From d5ea41a2a3d08f9e203252f1de5853f94870aab3 Mon Sep 17 00:00:00 2001 From: Andrew Zhou <30874884+0az@users.noreply.github.com> Date: Sun, 28 Oct 2018 22:33:35 -0700 Subject: Improve setup.cfg minimum version documentation - version: a960ee1c3f1d1d1067ec1e3c88dc345060bd33a4 - project_urls: df2246449c271c07586bcecc3eaa36e9b0e94e3d --- docs/setuptools.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'docs') diff --git a/docs/setuptools.txt b/docs/setuptools.txt index 9eec82f3..fe2a06f9 100644 --- a/docs/setuptools.txt +++ b/docs/setuptools.txt @@ -2475,10 +2475,10 @@ Metadata Key Aliases Type Minumum Version ============================== ================= ================= =============== name str -version attr:, file:, str +version attr:, file:, str 39.2.0 url home-page str download_url download-url str -project_urls dict +project_urls dict 38.3.0 author str author_email author-email str maintainer str @@ -2503,9 +2503,9 @@ obsoletes list-comma Options ------- -======================= =================================== ===== +======================= =================================== =============== Key Type Minimum Version -======================= =================================== ===== +======================= =================================== =============== zip_safe bool setup_requires list-semi install_requires list-semi @@ -2528,7 +2528,7 @@ exclude_package_data section namespace_packages list-comma py_modules list-comma data_files dict 40.5.0 -======================= =================================== ===== +======================= =================================== =============== .. note:: -- cgit v1.2.3 From 22bb74122729f7f7735db420ef32b7c578ca0d13 Mon Sep 17 00:00:00 2001 From: Andrew Zhou <30874884+0az@users.noreply.github.com> Date: Tue, 30 Oct 2018 09:26:10 -0700 Subject: Add version footnote --- docs/setuptools.txt | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) (limited to 'docs') diff --git a/docs/setuptools.txt b/docs/setuptools.txt index fe2a06f9..4e548066 100644 --- a/docs/setuptools.txt +++ b/docs/setuptools.txt @@ -2471,11 +2471,11 @@ Metadata The aliases given below are supported for compatibility reasons, but their use is not advised. -============================== ================= ================= =============== -Key Aliases Type Minumum Version -============================== ================= ================= =============== +============================== ================= ================= =============== ===== +Key Aliases Type Minumum Version Notes +============================== ================= ================= =============== ===== name str -version attr:, file:, str 39.2.0 +version attr:, file:, str 39.2.0 (1) url home-page str download_url download-url str project_urls dict 38.3.0 @@ -2493,19 +2493,22 @@ platforms platform list-comma provides list-comma requires list-comma obsoletes list-comma -============================== ================= ================= =============== +============================== ================= ================= =============== ===== .. note:: A version loaded using the ``file:`` directive must comply with PEP 440. It is easy to accidentally put something other than a valid version string in such a file, so validation is stricter in this case. +Notes: +1. The `version` file attribute has only been supported since 39.2.0. + Options ------- -======================= =================================== =============== -Key Type Minimum Version -======================= =================================== =============== +======================= =================================== =============== ===== +Key Type Minimum Version Notes +======================= =================================== =============== ===== zip_safe bool setup_requires list-semi install_requires list-semi @@ -2528,7 +2531,7 @@ exclude_package_data section namespace_packages list-comma py_modules list-comma data_files dict 40.5.0 -======================= =================================== =============== +======================= =================================== =============== ===== .. note:: -- cgit v1.2.3