Skip to content

Commit b1dfa48

Browse files
thomasbbrunnerdi
andauthored
Fixes inconsistencies in pyproject.toml documentation. (pypa#197)
* Minor improvements to pyproject.toml documentation. * Fixes readme field. --------- Co-authored-by: Dustin Ingram <[email protected]>
1 parent 9944026 commit b1dfa48

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

pyproject.toml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,22 +28,22 @@ description = "A sample Python project" # Optional
2828
# the body of text which users will see when they visit PyPI.
2929
#
3030
# Often, this is the same as your README, so you can just read it in from
31-
# that file directly (as we have already done above)
31+
# that file directly.
3232
#
3333
# This field corresponds to the "Description" metadata field:
3434
# https://packaging.python.org/specifications/core-metadata/#description-optional
3535
readme = "README.md" # Optional
3636

3737
# Specify which Python versions you support. In contrast to the
38-
# 'Programming Language' classifiers above, 'pip install' will check this
38+
# 'Programming Language' classifiers, 'pip install' will check this
3939
# and refuse to install the project if the version does not match. See
4040
# https://packaging.python.org/guides/distributing-packages-using-setuptools/#python-requires
41-
requires-python = ">=3.8"
41+
requires-python = ">=3.8" # Optional
4242

4343
# This is either text indicating the license for the distribution, or a file
44-
# that contains the license
44+
# that contains the license.
4545
# https://packaging.python.org/en/latest/specifications/core-metadata/#license
46-
license = {file = "LICENSE.txt"}
46+
license = {file = "LICENSE.txt"} # Optional
4747

4848
# This field adds keywords for your project which will appear on the
4949
# project page. What does your project relate to?
@@ -86,7 +86,7 @@ classifiers = [ # Optional
8686

8787
# Specify the Python versions you support here. In particular, ensure
8888
# that you indicate you support Python 3. These classifiers are *not*
89-
# checked by "pip install". See instead "python_requires" below.
89+
# checked by "pip install". See instead "requires-python".
9090
"Programming Language :: Python :: 3",
9191
"Programming Language :: Python :: 3.8",
9292
"Programming Language :: Python :: 3.9",

0 commit comments

Comments
 (0)