From 60b0e67c50eb21c179590dc3ca8d40d00fd4dadf Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Mon, 11 Apr 2022 23:16:39 +0100 Subject: [PATCH] Add deprecation notices to docs --- docs/userguide/declarative_config.rst | 6 +++++- docs/userguide/keywords.rst | 2 ++ docs/userguide/pyproject_config.rst | 2 +- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/userguide/declarative_config.rst b/docs/userguide/declarative_config.rst index 52379dbf1c6..2a65e6e3677 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 + ` for more information. + Compatibility with other tools ============================== diff --git a/docs/userguide/keywords.rst b/docs/userguide/keywords.rst index 5388ffea7f4..b1c9817e4cb 100644 --- a/docs/userguide/keywords.rst +++ b/docs/userguide/keywords.rst @@ -89,6 +89,8 @@ unless you need the associated ``setuptools`` feature. does not contain any code other than a namespace declaration. See the section below on :ref:`Namespace Packages` for more information. + *Deprecated in favor of native/implicit namespaces* (:pep:`420`). + ``test_suite`` A string naming a ``unittest.TestCase`` subclass (or a package or module containing one or more of them, or a method of such a subclass), or naming diff --git a/docs/userguide/pyproject_config.rst b/docs/userguide/pyproject_config.rst index 47c4511ebb4..e20f4ab9004 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