Update crate documentation #104
Merged
Conversation
This file contains 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
|
This is rebased on top of #102 to include all the remaining code changes.. |
9 tasks
Closed
waterst0ne
reviewed
Jul 23, 2022
waterst0ne
reviewed
Jul 23, 2022
waterst0ne
reviewed
Jul 23, 2022
waterst0ne
reviewed
Jul 23, 2022
waterst0ne
reviewed
Jul 23, 2022
|
Thanks for nits @waterst0ne .. Really helpful.. |
20 tasks
|
@waterst0ne Updated with your comments.. |
|
Rebased on latest #102 |
22 tasks
27 tasks
9 tasks
|
Rebased on top of #102 .. |
rajarshimaitra
force-pushed
the
docs
branch
from
0962181 to
e7b6854
Compare
|
Thanks @notmandatory for the 102 merge.. Rebased on master.. This is basic documentation update and should be straight forward to review.. |
26 tasks
|
@rajarshimaitra I added a commit with some small grammar and punctuation changes. For the punctuation I primarily added periods to the end of lines in the rust docs, which is how they do it in other rust docs I've seen. If these changes look OK feel free to merge the PR, or I'm happy to merge it tomorrow with your OK. |
|
Thanks @notmandatory for the review.. All looks good to me.. Merged.. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
After #99 the previous documentation have been removed and new docs as per
structoptsdocumentation. This PR adds more documentation across the crate..This PR is above #102 , to accommodate all the further refactoring changes.
The Readme About section have been updated with more details.. Readme format made aligned with the BDK project itself..
The Readme file is used itself as the crate level documentation in docs.rs too..
Checklists
All Submissions:
cargo fmtandcargo clippybefore committing