diff options
| author | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-05-16 18:36:00 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-05-16 18:36:00 +0100 |
| commit | 73bc126cd05b25a24e2a3e7ad347a245e980b673 (patch) | |
| tree | 7a3d1a72f4e58565d0c8f6eecc509f6e7c36fa31 /docs/userguide | |
| parent | 42d940f04e6d39e999ad184d4a6b5062957f4ae6 (diff) | |
| parent | 269f3acbf4e3a2f717fb37dc23ff48bf36b8bc2a (diff) | |
| download | python-setuptools-git-73bc126cd05b25a24e2a3e7ad347a245e980b673.tar.gz | |
Add deprecation messages for `namespace_packages` (#3262)
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/declarative_config.rst | 6 | ||||
| -rw-r--r-- | docs/userguide/pyproject_config.rst | 2 |
2 files changed, 6 insertions, 2 deletions
diff --git a/docs/userguide/declarative_config.rst b/docs/userguide/declarative_config.rst index 52379dbf..2a65e6e3 100644 --- a/docs/userguide/declarative_config.rst +++ b/docs/userguide/declarative_config.rst @@ -210,7 +210,7 @@ packages find:, find_namespace:, list-comma [# package_dir dict package_data section [#opt-1]_ exclude_package_data section -namespace_packages list-comma +namespace_packages list-comma [#opt-5]_ py_modules list-comma 34.4.0 data_files section 40.6.0 [#opt-4]_ ======================= =================================== =============== ========= @@ -243,6 +243,10 @@ data_files section 40.6.0 [# .. [#opt-4] ``data_files`` is deprecated and should be avoided. Please check :doc:`/userguide/datafiles` for more information. +.. [#opt-5] ``namespace_packages`` is deprecated in favour of native/implicit + namespaces (:pep:`420`). Check :doc:`the Python Packaging User Guide + <PyPUG:guides/packaging-namespace-packages>` for more information. + Compatibility with other tools ============================== diff --git a/docs/userguide/pyproject_config.rst b/docs/userguide/pyproject_config.rst index 7b8f8104..8558f5d7 100644 --- a/docs/userguide/pyproject_config.rst +++ b/docs/userguide/pyproject_config.rst @@ -94,7 +94,7 @@ Key Value Type (TOML) Notes ``py-modules`` array See tip below ``packages`` array or ``find`` directive See tip below ``package-dir`` table/inline-table Used when explicitly listing ``packages`` -``namespace-packages`` array Not necessary if you use :pep:`420` +``namespace-packages`` array **Deprecated** - Use implicit namespaces instead (:pep:`420`) ``package-data`` table/inline-table See :doc:`/userguide/datafiles` ``include-package-data`` boolean ``True`` by default ``exclude-package-data`` table/inline-table |