README: make the ringbuffer names link to the docs
#107
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
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
These links seemed to have disappeared between 0.14 and the current
mainbranch. Because theREADME.mdis synced with the module documentation, the links will also show up there. But they won't link to the version you're currently looking at, but always to the latest version on [docs.rs]. Still this is a small improvement that will probably make sense for most users.The alternative would be to write
[AllocRingBuffer], which makes sense for rustdoc, but won't create a valid link elsewhere (such as on GitHub).