-
Notifications
You must be signed in to change notification settings - Fork 251
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
Add support to declare multiple README files #118
Add support to declare multiple README files #118
Conversation
I think so, yes. |
cb3e0f7
to
f75b5e6
Compare
I rebased my branch to latest |
tests/masonry/builders/fixtures/with_readme_files/pyproject.toml
Outdated
Show resolved
Hide resolved
789bfad
to
6ec8c66
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the awesome suggestions.
I added my fixes to the code: please note that I rebased the branch to reduce the number of commits.
Comments about my fixes:
- I chose
isinstance(config["readme"], list)
as the TOML parser only deliverslist
-like objects, no need to check fortuple
. - About using a
Sequence
, please check my separate comment - Pluralized
Package.readme
(becamereadmes
) andreadme_type
=>description_type
- Added a test for validation fail when readme types mismatch
- Refactoring according to the comments
- Fixed a few glitches I found on the way
tests/masonry/builders/fixtures/with_readme_files/pyproject.toml
Outdated
Show resolved
Hide resolved
6ec8c66
to
ce15451
Compare
This reverts commit f101162.
This reverts commit f101162.
Resolves: python-poetry/poetry#873
This code reuses the
"readme"
entry in a way to allow the user to declare in the old way or the new way. The two following declarations become valid:Single file
Multiple files
If the user declares files in different formats, the strict validation will issue.