You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Be explicit about leading * when documenting *args, **kwargs. (#310)
This seem to be what most docstring involving args/kwargs are doing
including the example.py; Though I've seen other project be less
consistant, so make the suggestion explicit instead of letting users
infer from the example.
Other convention I've seen are:
- `*xi` , documented as `x1,x2, ..., xn : type`
- just the name without the leading `*`/`**`.
- prefixing `*` with `\\*`.
0 commit comments