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

What does the @ in poetry add pendulum@^2.0.5 in a docs example mean? #5136

Closed
1 task done
DFEvans opened this issue Feb 1, 2022 · 3 comments · Fixed by #5822
Closed
1 task done

What does the @ in poetry add pendulum@^2.0.5 in a docs example mean? #5136

DFEvans opened this issue Feb 1, 2022 · 3 comments · Fixed by #5822
Labels
area/docs Documentation issues/improvements

Comments

@DFEvans
Copy link

DFEvans commented Feb 1, 2022

  • I have searched the issues of this repo and believe that this is not a duplicate.

Issue

In the CLI docs page (cli.md), the documentation for add gives two examples for specifying a constraint:

poetry add pendulum@^2.0.5
poetry add "pendulum>=2.0.5"

In the first line, what is the meaning of @ in addition to ^? Is this a symbol that modifies the behaviour of ^, some shell-specific escape sequence (I know that < and > can be troublesome), or just a small typo? It's never referenced again in the accompanying text, or the Dependency Specification docs page (dependency-specification.md).

(It's been in the example ever since it was first added in c6a2d6e)

My reason for looking at this is that I've had another developer a little confused why poetry add [email protected] isn't working to update a required version. I think it's simply that @ isn't a valid specifier, and they've copied (part of) this example.

@DFEvans DFEvans added area/docs Documentation issues/improvements status/triage This issue needs to be triaged labels Feb 1, 2022
@dimbleby
Copy link
Contributor

dimbleby commented Jun 4, 2022

Looks like not a typo, the @ is usual in 'direct' references (files, git repositories) and poetry tolerates it (but as far as I can tell ignores it) in regular version specifiers at poetry add.

In particular poetry add [email protected] works just fine for me (with some package that actually exists)

@dimbleby
Copy link
Contributor

dimbleby commented Jun 4, 2022

also duplicates #3142

Copy link

github-actions bot commented Mar 1, 2024

This issue 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 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area/docs Documentation issues/improvements
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants