summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMike Taves <mwtoews@gmail.com>2022-11-26 13:54:56 +1300
committerMike Taves <mwtoews@gmail.com>2022-11-26 13:59:02 +1300
commitaa4920bad7aa02e793fb4b04a3fd025dc1d2ab8c (patch)
tree1c4a9a3e5f02a79d957b9b9a9006cbe4a91609c6 /docs
parent6f7dd7c12ceffa2aefe28c2fbafbad2273980b2b (diff)
downloadpython-setuptools-git-aa4920bad7aa02e793fb4b04a3fd025dc1d2ab8c.tar.gz
Improve example docs for setup.cfg and pyproject.toml
Diffstat (limited to 'docs')
-rw-r--r--docs/userguide/declarative_config.rst5
-rw-r--r--docs/userguide/pyproject_config.rst5
2 files changed, 8 insertions, 2 deletions
diff --git a/docs/userguide/declarative_config.rst b/docs/userguide/declarative_config.rst
index 3ef7b074..adedb0c0 100644
--- a/docs/userguide/declarative_config.rst
+++ b/docs/userguide/declarative_config.rst
@@ -25,10 +25,13 @@ boilerplate code in some cases.
[metadata]
name = my_package
version = attr: my_package.VERSION
+ author = Josiah Carberry
+ author_email = josiah_carberry@brown.edu
description = My package description
long_description = file: README.rst, CHANGELOG.rst, LICENSE.rst
keywords = one, two
- license = BSD 3-Clause License
+ python_requires = >=3.7
+ license = BSD-3-Clause
classifiers =
Framework :: Django
Programming Language :: Python :: 3
diff --git a/docs/userguide/pyproject_config.rst b/docs/userguide/pyproject_config.rst
index cc811ed7..ede19754 100644
--- a/docs/userguide/pyproject_config.rst
+++ b/docs/userguide/pyproject_config.rst
@@ -42,11 +42,14 @@ The ``project`` table contains metadata fields as described by
[project]
name = "my_package"
+ authors = [
+ {name = "Josiah Carberry", email = "josiah_carberry@brown.edu"},
+ ]
description = "My package description"
readme = "README.rst"
requires-python = ">=3.7"
keywords = ["one", "two"]
- license = {text = "BSD 3-Clause License"}
+ license = {text = "BSD-3-Clause"}
classifiers = [
"Framework :: Django",
"Programming Language :: Python :: 3",