docs: dash-dash-opt into literal or link #3328
Open
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
pajod
commented
Nov 24, 2024
Comment on lines
19
to
+20
| - allows to set wsgi application in config file using `wsgi_app` | ||
| - document `--timeout = 0` | ||
| - document ``--``:ref:`timeout=0<timeout>` |
There was a problem hiding this comment.
This is intentional. Looks weird, but only so because reStructuredText parsers are weird - no way to express a literal reference.
# 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.
Replace all the
--optthat sphinx might rewrite into–opt(typographical alternates, not accepted by argparse) by literals, or references (where applicable). Also change somehttps://references into internal ones, preventing unintended navigation between doc versions.