session: fix options docstring #5176
Merged
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
- Fix default options - Reorder according to cli argparse mapping - Add missing defaults (except deprecated keys) - Fix incorrect defaults - Fix set_option() docstring - Replace rst table with list-table from myst-parser extension - Reformat table and add key, type, default and description columns - Add all missing keys, including deprecated keys - Reorder keys according to default keys - Fix types and update descriptions - Add docstring tests
bastimeyer
force-pushed
the
session/fix-option-docs
branch
from
507ba94 to
9c54279
Compare
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.
#5173 (comment)
First commit is only meant for having some kind of public interface on the
Optionsclass for iterating its keys (as used in the added session options documentation tests), or for getting/setting values with the bracket syntax, which could be useful in plugins instead of using the{g,s}et_optionmethod.Third commit fixes the delimiter of the
http-query-paramsstring input, which was implemented incorrectly, but documented correctly.