Doc: use consistent repeated-args syntax #4583
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
For now, want to keep the "key=value, ..." form for Functions/Method signatures instead of using **kwargs, since that terminology hasn't been introduced. May switch signatures later, but if so, do them all, let's not be piecemeal. Signed-off-by: Mats Wichmann <mats@linux.com>
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.
For now, keep to the
key=value, ...form for Functions/Method signatures instead of using**kwargs, since that terminology hasn't been formally introduced. May switch signatures to a more Python-like syntax later, but if so, make a bulk switch, don't piecemeal - I'm assuming consistency is worth something here. Affects three functions:AddOption,ToolandDefaultEnvironment.Small wording tweaks to
AddOptionandDefaultEnvironmentas well, because sometimes it's hard to resist.Doc-only change.
Contributor Checklist:
CHANGES.txt(and read theREADME.rst)