summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAnderson Bravalheri <andersonbravalheri@gmail.com>2022-07-04 09:56:00 +0100
committerGitHub <noreply@github.com>2022-07-04 09:56:00 +0100
commit233c986f690a1f1bef222dd6f7fad803c4f41a6d (patch)
tree8fe53abbea4367becb0700124d76be342a4c4f27
parent156a75f880ec28755fa43ff95d7bd6166b4c76f7 (diff)
parentb422ddc51bfb6a79cad5c8bfa4ab2619400839ed (diff)
downloadpython-setuptools-git-233c986f690a1f1bef222dd6f7fad803c4f41a6d.tar.gz
[Doc] Ensure members of the build subcommand protocol are listed by autodoc (#3429)
-rw-r--r--docs/userguide/extension.rst1
-rw-r--r--setuptools/command/build.py2
2 files changed, 2 insertions, 1 deletions
diff --git a/docs/userguide/extension.rst b/docs/userguide/extension.rst
index 58c8ec19..e5fca01e 100644
--- a/docs/userguide/extension.rst
+++ b/docs/userguide/extension.rst
@@ -86,6 +86,7 @@ Supporting sdists and editable installs in ``build`` sub-commands
are encouraged to implement the following protocol:
.. autoclass:: setuptools.command.build.SubCommand
+ :members:
Adding Arguments
diff --git a/setuptools/command/build.py b/setuptools/command/build.py
index 1396afd5..283999da 100644
--- a/setuptools/command/build.py
+++ b/setuptools/command/build.py
@@ -41,7 +41,7 @@ class SubCommand(Protocol):
When creating an :pep:`editable wheel <660>`, ``setuptools`` will try to evaluate
custom ``build`` subcommands using the following procedure:
- 1. ``setuptools`` will set the ``editable_mode`` flag will be set to ``True``
+ 1. ``setuptools`` will set the ``editable_mode`` attribute to ``True``
2. ``setuptools`` will execute the ``run()`` command.
.. important::