We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 88b2792 commit 1164d54Copy full SHA for 1164d54
1 file changed
spin/cmds/util.py
@@ -127,7 +127,14 @@ def extend_command(
127
Command to extend.
128
doc : str
129
Replacement docstring.
130
- The wrapped function's docstring is also appended.
+ The decorated function's docstring is also appended.
131
+ This is done so that two modes of documenting are enabled:
132
+
133
+ 1. Extend original command documentation.
134
+ Do this by providing a docstring on the decorated function.
135
+ 2. Replace the original command's documentation.
136
+ Do this either by setting ``doc`` to a docstring, or by
137
+ setting ``doc=''`` and adding a docstring to the decorated function.
138
remove_args : tuple of str
139
List of arguments to remove from the parent command.
140
These arguments can still be set explicitly by calling
0 commit comments