diff options
author | Anderson Bravalheri <andersonbravalheri+github@gmail.com> | 2023-03-19 11:03:23 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-03-19 11:03:23 +0000 |
commit | 54da8b6d69b7333424eff305218a10d9605a7e36 (patch) | |
tree | f638fb29c2e3909c097084723d1b36ce72df849c | |
parent | bd04fc60505619755508ab8736286c6c6bc661b9 (diff) | |
download | python-setuptools-git-54da8b6d69b7333424eff305218a10d9605a7e36.tar.gz |
Apply suggestions from code review
Co-authored-by: Ed Morley <501702+edmorley@users.noreply.github.com>
-rw-r--r-- | setuptools/_normalization.py | 2 | ||||
-rw-r--r-- | setuptools/build_meta.py | 2 | ||||
-rw-r--r-- | setuptools/command/build.py | 2 | ||||
-rw-r--r-- | setuptools/command/build_py.py | 4 | ||||
-rw-r--r-- | setuptools/command/editable_wheel.py | 8 | ||||
-rw-r--r-- | setuptools/dist.py | 2 |
6 files changed, 10 insertions, 10 deletions
diff --git a/setuptools/_normalization.py b/setuptools/_normalization.py index c34f5ff7..31899f7a 100644 --- a/setuptools/_normalization.py +++ b/setuptools/_normalization.py @@ -81,7 +81,7 @@ def best_effort_version(version: str) -> str: f""" Version {version!r} is not valid according to PEP 440. - Please make sure specify a valid version for your package. + Please make sure to specify a valid version for your package. Also note that future releases of setuptools may halt the build process if an invalid version is given. """, diff --git a/setuptools/build_meta.py b/setuptools/build_meta.py index 3dfd6670..ee8ef13f 100644 --- a/setuptools/build_meta.py +++ b/setuptools/build_meta.py @@ -304,7 +304,7 @@ class _ConfigSettingsTranslator: f""" The arguments {bad_args!r} were given via `--global-option`. Please use `--build-option` instead, - `--global-option` is reserved to flags like `--verbose` or `--quiet`. + `--global-option` is reserved for flags like `--verbose` or `--quiet`. """, due_date=(2023, 9, 26), # Warning introduced in v64.0.1, 11/Aug/2022. ) diff --git a/setuptools/command/build.py b/setuptools/command/build.py index 8152658d..0f1d688e 100644 --- a/setuptools/command/build.py +++ b/setuptools/command/build.py @@ -23,7 +23,7 @@ class build(_build): subcommands = {cmd[0] for cmd in _build.sub_commands} if subcommands - _ORIGINAL_SUBCOMMANDS: SetuptoolsDeprecationWarning.emit( - "Directly usage of `distutils` commands", + "Direct usage of `distutils` commands", """ It seems that you are using `distutils.command.build` to add new subcommands. Using `distutils` directly is considered deprecated, diff --git a/setuptools/command/build_py.py b/setuptools/command/build_py.py index ccabc7b7..f094496e 100644 --- a/setuptools/command/build_py.py +++ b/setuptools/command/build_py.py @@ -336,9 +336,9 @@ class _IncludePackageDataAbuse: Python recognizes {importable!r} as an importable package[^1], but it is absent from setuptools' `packages` configuration. - This leads to an ambiguous overall configuration. If you want distribute this + This leads to an ambiguous overall configuration. If you want to distribute this package, please make sure that {importable!r} is explicitly added - the `packages` configuration field. + to the `packages` configuration field. Alternatively, you can also rely on setuptools' discovery methods (for example by using `find_namespace_packages(...)`/`find_namespace:` diff --git a/setuptools/command/editable_wheel.py b/setuptools/command/editable_wheel.py index fc0f4c56..ffcc2cc0 100644 --- a/setuptools/command/editable_wheel.py +++ b/setuptools/command/editable_wheel.py @@ -305,7 +305,7 @@ class editable_wheel(Command): If you are seeing this warning it is very likely that a setuptools plugin or customization overrides the `{cmd_name}` command, without taking into consideration how editable installs run build steps - starting from v64.0.0. + starting from setuptools v64.0.0. Plugin authors and developers relying on custom build steps are encouraged to update their `{cmd_name}` implementation considering the @@ -836,10 +836,10 @@ class _DebuggingTips(SetuptoolsWarning): _DETAILS = """ An error happened while installing `{project}` in editable mode. - The following steps are recommended to help debugging this problem: + The following steps are recommended to help debug this problem: - Try to install the project normally, without using the editable mode. - Does the error still persists? + Does the error still persist? (If it does, try fixing the problem before attempting the editable mode). - If you are using binary extensions, make sure you have all OS-level dependencies installed (e.g. compilers, toolchains, binary libraries, ...). @@ -847,7 +847,7 @@ class _DebuggingTips(SetuptoolsWarning): - If you (or your project dependencies) are using any setuptools extension or customization, make sure they support the editable mode. - After following the steps above, if the problem still persist and + After following the steps above, if the problem still persists and you think this is related to how setuptools handles editable installations, please submit a reproducible example (see https://stackoverflow.com/help/minimal-reproducible-example) to: diff --git a/setuptools/dist.py b/setuptools/dist.py index 5b4a9cb6..c75aaabe 100644 --- a/setuptools/dist.py +++ b/setuptools/dist.py @@ -825,7 +825,7 @@ class Distribution(_Distribution): "Invalid uppercase configuration", f""" Usage of uppercase key {opt!r} in {section!r} will not be supported in - future versions. Please use lowercase {lowercase_opt!r} instead + future versions. Please use lowercase {lowercase_opt!r} instead. """, see_docs="userguide/declarative_config.html", due_date=(2023, 9, 26), |