docs: wallet type docstrings #616
Conversation
reez
changed the title
reez
force-pushed
the
docstrings-more
branch
2 times, most recently
from
ff247a3 to
4ac00ac
Compare
|
rebased, updated to reflect current standard for docstrings, ready for review- |
| @@ -374,6 +416,7 @@ dictionary CanonicalTx { | |||
| ChainPosition chain_position; | |||
| }; | |||
|
|
|||
| /// Builds a [`FullScanRequest`]. | |||
There was a problem hiding this comment.
These links don't work in the KDocs. I'll send you a screenshot of what they look like, but I was thinking of removing them.
There was a problem hiding this comment.
Discussed on the Bindings Call to just re-visit this topic in a few months
| dictionary AddressInfo { | ||
| /// Child index of this address |
There was a problem hiding this comment.
I think the standard for Rust and Kotlin/Java is to have a full stop at the end of the first sentence, even if there is only one. I noticed that it's not always respected in the bdk docs, but then added when people point them out. In case the Rust docs are faulty of this, I suggest we simply fix here for the ffi docs.
There was a problem hiding this comment.
Discussed on the Bindings Call to just re-visit this topic in a few months
reez
force-pushed
the
docstrings-more
branch
from
4ac00ac to
cf5f714
Compare
|
rebased, should be good to go. |
|
Feel free to merge this is ready to go. |
Description
Adding some additional docstrings for
Wallet// ------------------------------------------------------------------------
// bdk_wallet crate - types module
// ------------------------------------------------------------------------
Notes to the reviewers
Changelog notice
Checklists
All Submissions:
cargo fmtandcargo clippybefore committingNew Features:
Bugfixes: