Skip to content

DOC: Do not use types for *args, **kwargs #585

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 17, 2024
Merged

DOC: Do not use types for *args, **kwargs #585

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
26629ff
DOC: Do not use types for *args, **kwargs
timhoffm Oct 16, 2024
5154b64
Merge branch 'main' into doc-args-kwargs
larsoner Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/format.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,11 +225,11 @@ description, they can be combined::
Input arrays, description of `x1`, `x2`.

When documenting variable length positional, or keyword arguments, leave the
leading star(s) in front of the name::
leading star(s) in front of the name and do not specify a type::

*args : tuple
*args
Additional arguments should be passed as keyword arguments
**kwargs : dict, optional
**kwargs
Extra arguments to `metric`: refer to each metric documentation for a
list of all possible arguments.

Expand Down
Loading