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

[1.8 backport] [1.8 backport] Add example for dependency with multiple extras #9217

Closed
wants to merge 1 commit into from

Conversation

neersighted
Copy link
Member

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: -

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

Not applicable, pure documentation change.

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 <bjorn@neersighted.com>
(cherry picked from commit 88311c9)
@neersighted neersighted added area/docs Documentation issues/improvements impact/docs Contains or requires documentation changes labels Mar 24, 2024
Copy link

github-actions bot commented Mar 24, 2024

Deploy preview for website ready!

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

Built with commit 27fbab2.
This pull request is being automatically deployed with vercel-action

Copy link

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 Apr 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area/docs Documentation issues/improvements impact/docs Contains or requires documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants