Open
Conversation
stefanv
reviewed
Dec 19, 2024
Comment on lines
-231
to
234
| *args | ||
| Additional arguments should be passed as keyword arguments | ||
| Additional arguments should be passed as positional arguments. | ||
| **kwargs | ||
| Extra arguments to `metric`: refer to each metric documentation for a | ||
| list of all possible arguments. |
Contributor
There was a problem hiding this comment.
Thanks for highlighting this confusing phrasing, @mwtoews.
Since this example is entirely made up, I was wondering if we can't come up with something more intuitive. E.g.:
def red_print(*args, **kwargs):
"""Print text in red.
Parameters
----------
*args
Positional arguments, passed to `print`.
**kwargs
Keyword arguments, passed to `print`.
...
This is not the best example, but it's late :) Something more computational would be good.
I think this was the original goal with the metric usage in **kwargs, but it doesn't really come across.
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
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.
This PR fixes the wording to describe
*argsas positional arguments, and adds a full stop at the end.