Repair some broken see also links in the doc #336
Merged
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
A few of the plugins used :doc: docstring tag to refer to another doc. This doc style doesn't render properly when viewing the docs. For example, take a look here: https://bandit.readthedocs.io/en/latest/plugins/b502_ssl_with_bad_version.html#b502-ssl-with-bad-version To fix this, I simply moved the link to the :seealso: block and reference the other function using the :func: tag. Signed-off-by: Eric Brown <[email protected]>
sigmavirus24
approved these changes
Jul 11, 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.
A few of the plugins used :doc: docstring tag to refer to another
doc. This doc style doesn't render properly when viewing the docs.
For example, take a look here:
https://bandit.readthedocs.io/en/latest/plugins/b502_ssl_with_bad_version.html#b502-ssl-with-bad-version
To fix this, I simply moved the link to the :seealso: block and
reference the other function using the :func: tag.
Signed-off-by: Eric Brown [email protected]