Fix cargo doc #1788
Merged
Fix cargo doc #1788
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
soareschen
requested review from
adizere,
ancazamfir and
romac
as code owners
mzabaluev
reviewed
Feb 16, 2022
Comment on lines
154
to
155
| /// [`tendermint_light_client_verifier::options::Options`] struct for use in | ||
| /// Tendermint-specific light client verification. |
There was a problem hiding this comment.
It would be better to shorten the text in the link:
/// [`Options`] struct for use in Tendermint-specific light client verification.
/// [`Options`]: tendermint_light_client_verifier::options::OptionsThere was a problem hiding this comment.
Hmm I tried and it don't seem like this style of link shortening works in Rustdoc.
Comment on lines
+2
to
+4
| //! [`ChainHandle`](crate::chain::handle::ChainHandle) can accept. | ||
| //! These types trickle down to the | ||
| //! [`ChainEndpoint`](crate::chain::ChainEndpoint) trait. |
There was a problem hiding this comment.
Good, but stylistically footnote-style markup reads better in code, like in my suggestion above.
romac
approved these changes
Feb 17, 2022
hu55a1n1
pushed a commit
to hu55a1n1/hermes
that referenced
this pull request
Sep 13, 2022
* Fix cargo doc errors * Fix cargo doc * Add CI for cargo doc * Fix cargo doc * Fix Markdown link * Fix review feedback
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.
Closes: #1776
Description
Todo:
PR author checklist:
unclog.docs/).Reviewer checklist:
Files changedin the GitHub PR explorer.