Format options for doctest directives #13107
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
AA-Turner
reviewed
Nov 7, 2024
AA-Turner
reviewed
Nov 7, 2024
AA-Turner
reviewed
Nov 7, 2024
AA-Turner
reviewed
Nov 7, 2024
|
|
||
| Whether to trim remove doctest flags (comments looking like | ||
| ``# doctest: FLAG, ...``) at the ends of lines and ``<BLANKLINE>`` markers | ||
| individually. Default is ``trim-doctest-flags``. |
There was a problem hiding this comment.
Should we have a :default: option to .. rst:directive:option::?
There was a problem hiding this comment.
Theoretically yes. In practice, I believe it's not worth it. Without checking, I assume only a minor part of options have a real default value, instead they are often flags, or the default is some form of "emtpy"/not given e.g. in the case of :caption:, or the default is a behavior that needs a sentence of description, and does not have a simple value to list in a :default: option.
So, I'm fine with writing out "Default is ..." for the cases that make sense.
Co-authored-by: Adam Turner <[email protected]>
AA-Turner
reviewed
Nov 13, 2024
AA-Turner
changed the title
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.
Convert to standard syntax conventions we use for directive options.