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

Document environment variable equivalent for each configuration option #6667

Closed
1 task done
s7m4b4 opened this issue Oct 1, 2022 · 3 comments · Fixed by #6711
Closed
1 task done

Document environment variable equivalent for each configuration option #6667

s7m4b4 opened this issue Oct 1, 2022 · 3 comments · Fixed by #6711
Labels
area/docs Documentation issues/improvements good first issue kind/enhancement Not a bug or feature, but improves usability or performance

Comments

@s7m4b4
Copy link

s7m4b4 commented Oct 1, 2022

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

Issue

In the configuration doc, there is reference to using environment variables instead of executing config commands i.e.
https://python-poetry.org/docs/configuration/#using-environment-variables

However for better ease of use (and dummies like me who are prone to make mistakes), it would be nice to have also display the env value for each configuration option, so it's easily copy pastable.
Example -

virtualenvs.in-project
Type: boolean
Default: None
Environment Variable: POETRY_VIRTUALENVS_IN_PROJECT
@s7m4b4 s7m4b4 added area/docs Documentation issues/improvements status/triage This issue needs to be triaged labels Oct 1, 2022
@dimbleby
Copy link
Contributor

dimbleby commented Oct 1, 2022

go for it! Docs merge requests usually seem to be welcome.

@ekralc ekralc removed the status/triage This issue needs to be triaged label Oct 2, 2022
@neersighted neersighted added kind/enhancement Not a bug or feature, but improves usability or performance good first issue labels Oct 2, 2022
@alejandro-angulo
Copy link
Contributor

alejandro-angulo commented Oct 5, 2022

I think this would be useful too. Here's some a version of the md file with envvar names inline with each confg's description https://github.com/alejandro-angulo/poetry/blob/master/docs/configuration.md (also submitted a PR just now).

(I wonder if there's some hugo magic that could be done to add this automatically 🤔 )

Copy link

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 Feb 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 good first issue kind/enhancement Not a bug or feature, but improves usability or performance
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants