Clarify docs #8280
Clarify docs #8280
Conversation
temeddix
changed the title
|
If this PR is merged, I will try to provide further improvements with Poetry experience for those using Python from Microsoft Store. This issue has been present for a long time since #5331. |
temeddix
changed the title
temeddix
changed the title
|
Isn't there anybody to review this? |
|
Deploy preview for website ready! ✅ Preview Built with commit b5e0d7c. |
| @@ -79,7 +84,7 @@ By default, Poetry is installed into a platform and user-specific directory: | |||
|
|
|||
| - `~/Library/Application Support/pypoetry` on MacOS. | |||
| - `~/.local/share/pypoetry` on Linux/Unix. | |||
| - `%APPDATA%\pypoetry` on Windows. | |||
| - `%APPDATA%\pypoetry` on Windows (If Python is installed via web installer). | |||
There was a problem hiding this comment.
Where is it installed if Python is installed through the Microsoft Store and POETRY_HOME has not been set? Or does installation just fail?
| The way to add Poetry to your PATH differs by platform. | ||
| For the changes in PATH to take effect, you should always restart the terminal or re-open the window. | ||
|
|
||
| - On Linux and macOS, open (or create) the shell file. | ||
| For example, if Bash is your default shell, you should be editing `$HOME/.bashrc` file. | ||
| The filepath and filename will be different depending on the default shell. | ||
| Typing `echo $SHELL` in your Terminal will tell you which shell you’re using. | ||
| Add `export PATH="$PATH:[PATH_OF_POETRY_DIRECTORY]/bin"` to the shell file, | ||
| changing `[PATH_OF_FLUTTER_GIT_DIRECTORY]` into the path of your Poetry directory. | ||
| - On Windows, From the Start search bar, enter `env` and open `Edit environment variables for your account`. | ||
| Under `User variables`, Find (or create) an entry called `Path` | ||
| and append the full path to Poetry binary using `;` as a separator from existing values. | ||
|
|
There was a problem hiding this comment.
I'd expect most developers know how to add something to their path. I understand that their are inexperienced users who don't know. But I'd put this at the end of this section so that the existing information, which I consider more relevant, is still at the top.
|
|
||
| ```bash | ||
| curl -sSL https://install.python-poetry.org | python3 - --uninstall | ||
| curl -sSL https://install.python-poetry.org | POETRY_UNINSTALL=1 python3 - |
There was a problem hiding this comment.
Why remove that? It shows one of the options that is described above?
Co-authored-by: Randy Döring <[email protected]>
Co-authored-by: Randy Döring <[email protected]>
Co-authored-by: Randy Döring <[email protected]>
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Pull Request Check List
I've discovered that there is plenty of room for improvement in the documentation. Considerable portion of Python coders are not professional programmers, so we need more guides about environment variables and PATH. Also, More easier description and crucial information about using Poetry on Windows and Python from MS Store were needed.
I am very much experienced with conda and pip, but the first impression of Poetry was quite frustrating. Adding this information to the docs will reduce the barrier considerably.