Skip to content

Commit

Permalink
Small rewording for user-facing text/docs
Browse files Browse the repository at this point in the history
  • Loading branch information
abravalheri committed Feb 13, 2023
1 parent c9513a5 commit 2bda269
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions changelog.d/3822.misc.2.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Added clarification about ``editable_wheel`` and ``dist_info`` CLI commands:
they should not be called directly with ``python setup.py ...`` instead they
are intended for internal use of ``setuptools`` (effectively as "private" commands).
Users are recommended to user build backend APIs (:pep:`517` and :pep:`660`)
in ``setuptools.build_meta``.
they should not be called directly with ``python setup.py ...``.
Instead they are reserved for internal use of ``setuptools`` (effectively as "private" commands).
Users are recommended to rely on build backend APIs (:pep:`517` and :pep:`660`)
exposed by ``setuptools.build_meta``.
2 changes: 1 addition & 1 deletion setuptools/command/dist_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
class dist_info(Command):
"""
This command is private and reserved for internal use of setuptools,
clients should use the ``setuptools.build_meta`` APIs.
users should rely on ``setuptools.build_meta`` APIs.
"""

description = "DO NOT CALL DIRECTLY, INTERNAL ONLY: create .dist-info directory"
Expand Down
2 changes: 1 addition & 1 deletion setuptools/command/editable_wheel.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ def convert(cls, mode: Optional[str]) -> "_EditableMode":
class editable_wheel(Command):
"""Build 'editable' wheel for development.
This command is private and reserved for internal use of setuptools,
clients should use the ``setuptools.build_meta`` APIs.
users should rely on ``setuptools.build_meta`` APIs.
"""

description = "DO NOT CALL DIRECTLY, INTERNAL ONLY: create PEP 660 editable wheel"
Expand Down

0 comments on commit 2bda269

Please sign in to comment.