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

Fix documentation for default format option for include and exclude #8852

Merged
merged 2 commits into from
Jan 10, 2024

Conversation

zanieb
Copy link
Contributor

@zanieb zanieb commented Jan 5, 2024

The existing documentation is incorrect, which confused me when attempting to include a directory.

I verified this behavior by building a package with include and exclude and inspecting the tarballs created.

I'd appreciate if someone pointed me to the code for this — I tried to find it but could not :)

Pull Request Check List

Closes #8698

  • Added tests for changed code.
  • Updated documentation for changed code.

@Secrus
Copy link
Member

Secrus commented Jan 5, 2024

This code lives in poetry-core repo. Namely here and here.

@zanieb
Copy link
Contributor Author

zanieb commented Jan 5, 2024

Ah interesting thank you! No wonder I couldn't find it with a search :)

@dimbleby
Copy link
Contributor

dimbleby commented Jan 5, 2024

cf #8698

@zanieb
Copy link
Contributor Author

zanieb commented Jan 6, 2024

As far as I can tell, this should be ready to review — I agree with the discussion in the issue that the documentation should be corrected separately from considering if this behavior is correct.

@radoering radoering added the impact/docs Contains or requires documentation changes label Jan 9, 2024
Copy link

github-actions bot commented Jan 9, 2024

Deploy preview for website ready!

✅ Preview
https://website-kg6zyfbv9-python-poetry.vercel.app

Built with commit 380ffa7.
This pull request is being automatically deployed with vercel-action

docs/pyproject.md Outdated Show resolved Hide resolved
Co-authored-by: Randy Döring <[email protected]>
@radoering radoering merged commit 05f39ef into python-poetry:master Jan 10, 2024
18 checks passed
Copy link

github-actions bot commented Mar 3, 2024

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 3, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
impact/docs Contains or requires documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Default for the include flag is sdist only, not sdist AND wheel
4 participants