[1.8 backport] [1.8 backport] Add example for dependency with multiple extras #9217
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The currently existing example on how to install dependency extras only shows a single dependency:
`fastapi = {version="^0.92.0", extras=["all"]}`
Since right before this example it is shown how to install multiple extras using the command line interface, this can be confusing and lead to hard to understand missing dependencies:
`poetry install --extras "mysql pgsql"`
Note that the CLI has quotes around both extras and no commas, while in pyproject.toml each extra *must* be quoted and comma-separated, which is currently not documented.
(cherry picked from commit 9cda043)
Signed-off-by: Bjorn Neergaard <[email protected]>
(cherry picked from commit 88311c9)
neersighted
added
area/docs
|
Deploy preview for website ready! ✅ Preview Built with commit 27fbab2. |
|
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. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Backport #9215 to 1.8
Backport #9138 to 1.8
The currently existing example on how to install dependency extras only shows a single dependency:
fastapi = {version="^0.92.0", extras=["all"]}Since right before this example it is shown how to install multiple extras using the command line interface, this can be confusing and lead to hard to understand missing dependencies:
poetry install --extras "mysql pgsql"Note that the CLI has quotes around both extras and no commas, while in pyproject.toml each extra must be quoted and comma-separated, which is currently not documented.
Thus the change adds an example with more than one extra, based on pandas.
Pull Request Check List
Resolves: -
Not applicable, pure documentation change.