Add link to dependency specification in the add command documentation #3573
Labels
area/docs
Documentation issues/improvements
Comments
tpow
added
area/docs
Secrus
added
Good First Issue
and removed
status/triage
|
PRs on that are welcome. |
Secrus
added a commit
to Secrus/poetry
that referenced
this issue
May 20, 2022
…thon-poetry#3573, python-poetry#2211, python-poetry#521 and PR python-poetry#2414 - Added section about `extras` in `dependency-specification.md` (python-poetry#2414) - Added note about VCS inclusion and exclusion in `include`/`exclude` sections of `pyproject.toml` (python-poetry#4800) - Added link to dependency specification in `add` command documentation (python-poetry#3573) - Added more info on default behaviour and cleaned up `virtualenv.in-project` setting documentation (python-poetry#3709) - Added missing configuration options to `configuration.md` (python-poetry#2211)
1 task
neersighted
pushed a commit
that referenced
this issue
May 23, 2022
…5656) * Changes in docs for Issues #4800, #3709, #3573, #2211, #521 and PR #2414 - Added section about `extras` in `dependency-specification.md` (#2414) - Added note about VCS inclusion and exclusion in `include`/`exclude` sections of `pyproject.toml` (#4800) - Added link to dependency specification in `add` command documentation (#3573) - Added more info on default behaviour and cleaned up `virtualenv.in-project` setting documentation (#3709) - Added missing configuration options to `configuration.md` (#2211) Co-authored-by: Arun Babu Neelicattu <arun.neelicattu@gmail.com>
Merged
|
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. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Issue
It took me much too long to figure out how to specify package versions and what the caret meant. I looked at the documentation for the
addcommand, but it only gives a cursory overview of setting constraints. I tried to find it with Google and ended up with PEP-440 which was good, but doesn't explain the caret. For some reason I completely missed the dependency specification in the Poetry documentation sidebar. I guess that is not the terminology I was looking for, even though it makes sense.Adding a message like the following to the Add command documentation would really help:
I think part of what made this difficult is that it is a different mindset than how I normally work with python packages. With pip, I'm typically installing an exact version or latest. With poetry, I'm trying to put constraints in place so it can upgrade reasonably "safely" and get me the version I want now. I therefore needed more details about how to specify the constraints.
The text was updated successfully, but these errors were encountered: