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

Add example for dependency with multiple extras #9138

Merged
merged 3 commits into from
Mar 16, 2024
Merged

Add example for dependency with multiple extras #9138

merged 3 commits into from
Mar 16, 2024

Conversation

JSchoeck
Copy link
Contributor

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.

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

github-actions bot commented Mar 16, 2024

Deploy preview for website ready!

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

Built with commit 315b6ea.
This pull request is being automatically deployed with vercel-action

JSchoeck and others added 2 commits March 16, 2024 15:36
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.
@radoering radoering enabled auto-merge (squash) March 16, 2024 14:36
@radoering radoering merged commit 9cda043 into python-poetry:main Mar 16, 2024
21 checks passed
@JSchoeck JSchoeck deleted the patch-1 branch March 17, 2024 22:10
neersighted pushed a commit to neersighted/poetry that referenced this pull request Mar 24, 2024
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]>
neersighted pushed a commit to neersighted/poetry that referenced this pull request Mar 24, 2024
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]>
neersighted pushed a commit to neersighted/poetry that referenced this pull request Mar 24, 2024
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]>
neersighted pushed a commit to neersighted/poetry that referenced this pull request Mar 24, 2024
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]>
neersighted pushed a commit to neersighted/poetry that referenced this pull request Mar 24, 2024
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]>
neersighted pushed a commit to neersighted/poetry that referenced this pull request Mar 24, 2024
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]>
@neersighted neersighted added the area/docs Documentation issues/improvements label Mar 24, 2024
neersighted pushed a commit to neersighted/poetry that referenced this pull request Mar 24, 2024
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]>
neersighted pushed a commit to neersighted/poetry that referenced this pull request Mar 24, 2024
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]>
neersighted pushed a commit to neersighted/poetry that referenced this pull request Mar 24, 2024
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 pushed a commit to neersighted/poetry that referenced this pull request Mar 24, 2024
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)
radoering pushed a commit to neersighted/poetry that referenced this pull request Apr 23, 2024
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)
neersighted pushed a commit that referenced this pull request Apr 23, 2024
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)
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.

3 participants