Fixed docs(rs) #365
Merged
Fixed docs(rs) #365
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
These features were previously forgotten and without them the docs.rs doc is not that great. :(
Previously only `global-context-less-secure` was shown in the doc even though `global-context` may also work. This was strictly correct because `global-context` implies `global-context-less-secure` which is also documented but people could miss it or forget about it and then worry about security or worse, enable less secure feature. Calling out both fetures seems useful, even important and thankfully doesn't seem to cause too much noise in the docs.
|
@tcharding not sure if you know, to look how it'll be rendered on docsrs you need to set RUSTDOCFLAGS: |
apoelstra
approved these changes
Jan 7, 2022
I did not know this, thanks. |
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.
Sadly, I missed two details in #353: features missing in docs.rs configuration and
global-contextbeing a bit confusing.This PR fixes those, see commit messages for details.