update pyproject readme docs#5158
Conversation
|
Deploy preview for website ready! Built with commit 54da53e. |
docs/pyproject.md
Outdated
| ```toml | ||
| [tool.poetry] | ||
| # ... | ||
| readme = "./README.md" |
There was a problem hiding this comment.
I don't think we need ./ prefix. It is unnecessary, as it points to the same directory and can be confusing.
There was a problem hiding this comment.
okay np I fixed that, looks better now. thanks for the review!
|
I will have to double check, but I think this might be outdated as we've landed support for multiple README files that get combined. |
|
Yeah, we've added support for A quick touchup to reflect that would be appreciated! |
|
@patrick-ryan are you still up for completing this? |
|
yep I'll take a look at this, thanks for the ping |
|
okay updated to include the option of specifying a list of readme paths, let me know if that looks okay |
Co-authored-by: Bjorn Neergaard <[email protected]>
Co-authored-by: Bjorn Neergaard <[email protected]>
Co-authored-by: Bjorn Neergaard <[email protected]>
Co-authored-by: Bjorn Neergaard <[email protected]>
Co-authored-by: Bjorn Neergaard <[email protected]>
…k-ryan/poetry into 5069-pyproject-readme-docs-update
neersighted
left a comment
neersighted
left a comment
There was a problem hiding this comment.
Also, I see you've committed most of my suggestions -- the line wrapping will be broken -- could you please reflow these paragraphs to be 80 columns wide?
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
4 participants
Pull Request Check List
Resolves: #5069
I rendered the file in vscode, but let me know if there's a way to generate + host the docs locally so I can preview, thanks!