Skip to content

Commit 54da53e

Browse files
committed
update pyproject readme docs, rewrap 80
1 parent 9bcead8 commit 54da53e

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

docs/pyproject.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -106,16 +106,18 @@ maintainers = [
106106

107107
## readme
108108

109-
A path, or list of paths corresponding to the README file(s) of the package. **Optional**
109+
A path, or list of paths corresponding to the README file(s) of the package.
110+
**Optional**
110111

111112
The file(s) can be of any format, but if you intend to publish to PyPI keep the
112113
[recommendations for a PyPI-friendly README](
113-
https://packaging.python.org/en/latest/guides/making-a-pypi-friendly-readme/)
114-
in mind. README paths are implicitly relative to `pyproject.toml`.
114+
https://packaging.python.org/en/latest/guides/making-a-pypi-friendly-readme/) in
115+
mind. README paths are implicitly relative to `pyproject.toml`.
115116

116-
The contents of the README file(s) are used to populate the
117-
[Description field](https://packaging.python.org/en/latest/specifications/core-metadata/#description-optional)
118-
of your distribution's metadata (similar to `long_description` in setuptools). When multiple files are specified, they are concatenated with newlines.
117+
The contents of the README file(s) are used to populate the [Description
118+
field](https://packaging.python.org/en/latest/specifications/core-metadata/#description-optional)
119+
of your distribution's metadata (similar to `long_description` in setuptools).
120+
When multiple files are specified they are concatenated with newlines.
119121

120122
```toml
121123
[tool.poetry]

0 commit comments

Comments
 (0)