diff options
| author | Brody Rampono <64628500+brampono@users.noreply.github.com> | 2022-07-25 14:07:35 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-25 14:07:35 +0800 |
| commit | ba7db83ae7080979cbb650f3efb74373544589a5 (patch) | |
| tree | 6cefc0d494d954bdfbf7af99f1d9022e9fcb3cef /docs | |
| parent | 417018d3299bb33e87d2fccec48790cf3e9dd797 (diff) | |
| download | python-setuptools-git-ba7db83ae7080979cbb650f3efb74373544589a5.tar.gz | |
Fix typo `find_namespaces:` to `find_namespace:`
I believe the correct `setup.cfg` packaging option is `find_namespace:`, not `find_namespaces:`
I can't find any other references to `find_namespaces` in the docs or repository.
Using `find_namespaces:` causes packaging to fail. Example to reproduce:
```
.
├── pyproject.toml
├── setup.cfg
└── src
├── pkg1
│ └── namespace
│ └── __init__.py
└── pkg2
└── __init__.py
```
Contents of `pyproject.toml`:
```
[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"
```
Contents of `setup.cfg`:
```
[metadata]
name = pkg_test
[options]
packages = find_namespaces:
package_dir =
=src
[options.packages.find]
where = src
```
```
$ pip install .
> ...
> error: package directory 'src/find_namespaces:' does not exist
> ...
```
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/userguide/quickstart.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst index 6c39c352..64fc3e63 100644 --- a/docs/userguide/quickstart.rst +++ b/docs/userguide/quickstart.rst @@ -186,9 +186,9 @@ found, as shown in the example below: .. code-block:: ini [options] - packages = find: # OR `find_namespaces:` if you want to use namespaces + packages = find: # OR `find_namespace:` if you want to use namespaces - [options.packages.find] # (always `find` even if `find_namespaces:` was used before) + [options.packages.find] # (always `find` even if `find_namespace:` was used before) # This section is optional # Each entry in this section is optional, and if not specified, the default values are: # `where=.`, `include=*` and `exclude=` (empty). |
