Skip to content

types: Are docs on the version specific types ok? #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tcharding opened this issue Feb 12, 2025 · 1 comment
Open

types: Are docs on the version specific types ok? #59

tcharding opened this issue Feb 12, 2025 · 1 comment

Comments

@tcharding
Copy link
Member

Currently the types crate uses re-exports so that for a specific Core version the type exists e.g., v18::CreateWallet is a re-export of v17::CreateWallet but v25::CreateWallet is not (because the JSON returned in Core v25 changed).

Note also that while writing the structs in types I used the docs from bitcoin-cli hitting a bitcoind instance for the version in question. This means that the docs on v18::CreateWallet are actually the docs returned by bitcoind v17.

This would not be a problem if the docs didn't change meaningfully between Core versions without a code change as well but I do not know if that is the case.

@GideonBature
Copy link
Contributor

I think docs on version specifics where a method changed significantly is very okay. I feel reflecting that change brings about more clarity.

tcharding added a commit to tcharding/corepc that referenced this issue May 2, 2025
This TODO is described by issue rust-bitcoin#59 on github. Remove it.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants