Do some docs fixes #134
Do some docs fixes #134
Conversation
|
Rebased, no other changes. |
|
Found some other links that were not working as intended, pushed on top as a separate patch. |
src/hrp.rs
Outdated
| @@ -1,6 +1,9 @@ | |||
| // SPDX-License-Identifier: MIT | |||
|
|
|||
| //! Re-exports the hrp types from [`primitives::hrp`] to make importing ergonomic for the top level APIs. | |||
| //! Re-exports the HRP types from the [`primitives::hrp`] to make importing ergonomic for the | |||
There was a problem hiding this comment.
In f3bfb62
If you are going to add the you should add module or something after the module name.
There was a problem hiding this comment.
Ok, I just dropped this whole change and stuck with what the patch claimed to be doing - fix the links.
src/primitives/encode.rs
Outdated
| @@ -7,7 +7,7 @@ | |||
| //! prepending HRP strings etc. | |||
| //! | |||
| //! In general, directly using these adaptors is not very ergonomic, and users are recommended to | |||
| //! instead use the higher-level functions at the root of this crate. | |||
| //! instead use the higher crate level API. | |||
There was a problem hiding this comment.
In aec24d3:
I think higher-level crate API scans better. You could use higher crate-level API if you want to indicate that the API is "crate level", but I think you need a hyphen or else this is hard to read.
There was a problem hiding this comment.
Oh, I see, you fix this later in 738a7f4.
There was a problem hiding this comment.
Yeah, sorry about that. There were two different instances so I did them together in a separate patch. Bit confusing, my bad.
|
ec5eb94 looks good aside from a couple nits. |
|
will let @clarkmoody review before merging |
tcharding
force-pushed
the
10-04-docs
branch
from
651142f
to
f256f62
Compare
|
Rebased, no other changes. |
Currently we have docs for public modules in two places and these are joined together when rendered as HTML. Remove the rustdoc strings from `lib.rs` and defer to the modules for the module level docs.
Fix cut'n'pasta error, this is the `hrp` struct not an hrpstring.
This line is a bit stale, since it was written we have added multiple crate level APIs. Use the same wording as in the `decode` module docs.
The wording is a bit iffy, fix it up.
Bips don't need code ticks (by convention). Also the ticks do not match up with the link so in HTML they are not links.
|
Rebased, no other changes. |
Do a bunch of rustdocs fixes.