Skip to content

Commit aa4920b

Browse files
committed
Improve example docs for setup.cfg and pyproject.toml
1 parent 6f7dd7c commit aa4920b

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

docs/userguide/declarative_config.rst

+4-1
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,13 @@ boilerplate code in some cases.
2525
[metadata]
2626
name = my_package
2727
version = attr: my_package.VERSION
28+
author = Josiah Carberry
29+
author_email = [email protected]
2830
description = My package description
2931
long_description = file: README.rst, CHANGELOG.rst, LICENSE.rst
3032
keywords = one, two
31-
license = BSD 3-Clause License
33+
python_requires = >=3.7
34+
license = BSD-3-Clause
3235
classifiers =
3336
Framework :: Django
3437
Programming Language :: Python :: 3

docs/userguide/pyproject_config.rst

+4-1
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,14 @@ The ``project`` table contains metadata fields as described by
4242
4343
[project]
4444
name = "my_package"
45+
authors = [
46+
{name = "Josiah Carberry", email = "[email protected]"},
47+
]
4548
description = "My package description"
4649
readme = "README.rst"
4750
requires-python = ">=3.7"
4851
keywords = ["one", "two"]
49-
license = {text = "BSD 3-Clause License"}
52+
license = {text = "BSD-3-Clause"}
5053
classifiers = [
5154
"Framework :: Django",
5255
"Programming Language :: Python :: 3",

0 commit comments

Comments
 (0)