Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update pyproject readme docs #5158

Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions docs/pyproject.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,21 @@ This is a list of maintainers and should be distinct from authors. Maintainers m

## readme

The readme file of the package. **Optional**
The path to the readme file of the package. **Optional**

The file can be either `README.rst` or `README.md`.
The file should be in either Markdown (.md) or reStructuredText (.rst)
neersighted marked this conversation as resolved.
Show resolved Hide resolved
format. The path is relative to the directory containing the
`pyproject.toml`.

The file contents becomes the
patrick-ryan marked this conversation as resolved.
Show resolved Hide resolved
[Description field](https://packaging.python.org/en/latest/specifications/core-metadata/#description-optional)
in a PyPI build (similar to `long_description` in setuptools).

```toml
[tool.poetry]
# ...
readme = "./README.md"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need ./ prefix. It is unnecessary, as it points to the same directory and can be confusing.

Copy link
Contributor Author

@patrick-ryan patrick-ryan May 17, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay np I fixed that, looks better now. thanks for the review!

```

## homepage

Expand Down