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

Change docs to use --only main syntax, and add missing argument to Dockerfile example #8921

Merged
merged 2 commits into from
Jan 30, 2024

Conversation

shawnz
Copy link
Contributor

@shawnz shawnz commented Jan 29, 2024

This PR describes a suggestion which I believe improves upon two small issues I have with the docs regarding the --without dev/--only main option for the poetry install command.

  1. The Commands page disagrees with the deprecation warning when using the deprecated --no-dev option: the Commands page suggests using --without dev instead, but the deprecation warning suggests using --only main here:

    ("no-dev", "only", MAIN_GROUP),

    To resolve this, I updated the Commands page to suggest both options. Personally, I think --only main is preferrable overall because it works even if the dev dependency group doesn't exist, but it might be helpful for readers to know that both options are viable.

  2. The FAQ entry about avoiding Docker cache busting doesn't apply either of the --without dev or --only main options to the first install statement, but rather only the second install statement. Based on my testing, this causes dev dependencies to get installed, which I think is not intended.

    To resolve this I added --only main to the first install statement, and also changed the second install statement to use the --only main syntax rather than the --without dev syntax for the reasons described above.

@shawnz
Copy link
Contributor Author

shawnz commented Jan 30, 2024

Based on an initial positive response that --only main is preferable here, I just added a follow up commit which swaps the order of all the examples so that --only main is suggested first before --without dev

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

Deploy preview for website ready!

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

Built with commit 8c8ee85.
This pull request is being automatically deployed with vercel-action

@radoering radoering merged commit 776fcb8 into python-poetry:master Jan 30, 2024
20 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.

2 participants