From ba7db83ae7080979cbb650f3efb74373544589a5 Mon Sep 17 00:00:00 2001 From: Brody Rampono <64628500+brampono@users.noreply.github.com> Date: Mon, 25 Jul 2022 14:07:35 +0800 Subject: Fix typo `find_namespaces:` to `find_namespace:` MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 > ... ``` --- docs/userguide/quickstart.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') 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). -- cgit v1.2.1