Fix documentation warnings #113
Merged
Conversation
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
|
I'm okay with dropping the code block changes due to rust-lang/rust#38739 |
whitequark
reviewed
Jan 4, 2018
src/lib.rs
Outdated
| @@ -10,16 +10,14 @@ | |||
| //! for writing applications but also to be a toolbox of networking primitives, so | |||
| //! every layer is fully exposed and documented. | |||
| //! | |||
| //! When discussing networking stacks and layering, often the [OSI model][osi] is invoked. | |||
| //! When discussing networking stacks and layering, often the [OSI model](osi) is invoked. | |||
There was a problem hiding this comment.
Wait, what? How is this legal Markdown?
There was a problem hiding this comment.
Its not :(. I was playing around with some stuff and it got lumped in here.
src/phy/mod.rs
Outdated
| @@ -17,73 +17,71 @@ | |||
| //! An implementation of the [Device](trait.Device.html) trait for a simple hardware | |||
| //! Ethernet controller could look as follows: | |||
| //! | |||
| /*! | |||
| ```rust | |||
There was a problem hiding this comment.
This change makes it a real pain in the ass to update large code blocks.
There was a problem hiding this comment.
Agreed. If we're okay with some extra warnings, I'd be okay with going back to /*!.
|
Updated to use |
There are several warnings that are thrown when running `cargo doc`. Fix these warnings.
whitequark
approved these changes
Jan 5, 2018
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.
There are several warnings that are thrown when running
cargo doc. Fixthese warnings.