-
-
Notifications
You must be signed in to change notification settings - Fork 164
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Convention for specifying that arguments are keyword only? #330
Comments
There's no standard way to do this. There's def my_func(a, *, b, c, d=None):
""" My function does stuff
a : object
Something about `a`.
b : object, keyword-only
Something about `b`.
c : object, keyword-only
Something about `c`.
d : object, optional, keyword-only
""" |
Personal opinion: keyword-only (and positional-only) are just syntactic usage aspects. They don't carry information for understanding the function and its parameters. I therefore propose that it's sufficient to let the user infer the usage from the signature and would not document that aspect in the parameters section at all. |
Is there a standard way for the docstring to tell the user that the arguments (or following arguments) are keyword only? Other than some note for each argument? I mean for a situation like this:
The text was updated successfully, but these errors were encountered: