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.

Sign up for GitHub

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

[document] Mention poetry.toml #5492

Merged
merged 5 commits into from
May 23, 2022
Merged

[document] Mention poetry.toml #5492

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
16a4b64
Mention poetry.toml
majiang Apr 26, 2022
d781ecd
Update docs/configuration.md
majiang May 13, 2022
6b04d00
Update configuration.md
majiang May 22, 2022
2cc53b8
Update docs/configuration.md
majiang May 23, 2022
6356cf5
Update docs/configuration.md
neersighted May 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ by passing the `--local` option to the `config` command.
poetry config virtualenvs.create false --local
```

{{% note %}}
Your local configuration of Poetry application is stored in `poetry.toml` file,
neersighted marked this conversation as resolved.
Show resolved Hide resolved
which is separate from `pyproject.toml`.
You should not check-in this file into your repository.
majiang marked this conversation as resolved.
Show resolved Hide resolved
majiang marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not entirely true or enforced. I'd reword it to suggest it is recommended not to commit it as it may contain user specific configuration or sensitive information.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reworded!

{{% /note %}}

## Listing the current configuration

To list the current configuration you can use the `--list` option
Expand Down