Skip to content

Better explain how to document extended commands #310

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

Open
stefanv wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −1
Open

Better explain how to document extended commands #310

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 8 additions & 1 deletion spin/cmds/util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,14 @@ def extend_command(
Command to extend.
doc : str
Replacement docstring.
The wrapped function's docstring is also appended.
The decorated function's docstring is also appended.
This is done so that two modes of documenting are enabled:

1. Extend original command documentation.
Do this by providing a docstring on the decorated function.
2. Replace the original command's documentation.
Do this either by setting ``doc`` to a docstring, or by
setting ``doc=''`` and adding a docstring to the decorated function.
remove_args : tuple of str
List of arguments to remove from the parent command.
These arguments can still be set explicitly by calling
Expand Down
Loading