types: Improve the version specific SSOT docs#142
Merged
tcharding merged 2 commits intorust-bitcoin:masterfrom May 2, 2025
Merged
types: Improve the version specific SSOT docs#142tcharding merged 2 commits intorust-bitcoin:masterfrom
tcharding merged 2 commits intorust-bitcoin:masterfrom
Conversation
This TODO is described by issue rust-bitcoin#59 on github. Remove it.
The module docs in each version specific module (e.g. `types::v17`) are supposed to be the single source of truth for devs trying to work out which methods are supported and how. Make an effort to better present the information. Note that a bunch docs for methods marked as TODO may be incorrect re version vs version + model. This doesn't matter right now since they will be checked when implemented and also TODO implies no guarantees (in my mind anyway). Note also issue rust-bitcoin#144. `verify` does not check the Returns column against the `Method` constructor type. Close: rust-bitcoin#109
tcharding
force-pushed
the
04-30-update-status-column
branch
from
2e315f5 to
4946066
Compare
tcharding
changed the title
Returns and Notes columns
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The module docs in each version specific module (e.g.
types::v17) are supposed to be the single source of truth for devs trying to work out which methods are supported and how.Make an effort to better present the information.
Note that a bunch docs for methods marked as TODO may be incorrect re version vs version + model. This doesn't matter right now since they will be checked when implemented and also TODO implies no guarantees (in my mind anyway).
Note also issue #144.
verifydoes not check the Returns column against theMethodconstructor type.Close: #109