docs: add existing project quickstart - #11088
Open
Mohamedajab wants to merge 4 commits into
Open
Mohamedajab wants to merge 4 commits into
Mohamedajab wants to merge 4 commits into
Conversation
There was a problem hiding this comment.
Hey - I've found 1 issue
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="docs/basic-usage.md" line_range="36-37" />
<code_context>
+poetry run pytest
+```
+
+Alternatively, use [`poetry env activate`]({{< relref "managing-environments#activating-the-environment" >}})
+to print the command that activates the environment in your shell.
+
+To add or remove a dependency, use [`poetry add`]({{< relref "cli#add" >}}) or
</code_context>
<issue_to_address>
**nitpick:** The quickstart tells users to run `poetry env activate` but only explains that it prints an activation command; running it by itself leaves the current shell unactivated, so users who follow this alternative do not enter the project's environment.
**Triggers:** When a contributor chooses shell activation instead of `poetry run`.
**Suggested fix:** Show how to evaluate the output for the relevant shell, such as `eval "$(poetry env activate)"` for Bash/Zsh, or explicitly tell users to run the printed command.
````suggestion
Alternatively, in Bash or Zsh, evaluate the output of [`poetry env activate`]({{< relref "managing-environments#activating-the-environment" >}}):
```bash
eval "$(poetry env activate)"
```
````
</issue_to_address>Sourcery assessment
Approved.
This branch has not been deployed
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds a short quickstart for contributors joining an existing Poetry project. It explains installing from
pyproject.tomlandpoetry.lock, running commands in the project environment, and updating dependencies through Poetry.Resolves #8131
Pull Request Check List