Update documentation on setting up shell completions #3183
Conversation
I was not able to setup shell completion in my 'Bash' shell until I ran into python-poetry/poetry#2295 My submission is a solution that worked without any issues for me
|
You are responsible for setting up the bash completion correctly that loads script from that location. Your solution works, but it brings extra overhead every time you start a new shell. You may list it as an alternative solution instead of overwriting the original. |
|
Thanks for the review frostming! I updated the script to list this |
CONTRIBUTING.md
Outdated
| PDM docs development requires a few dependencies. Install them as: | ||
|
|
||
| ```bash | ||
| sudo apt install mkdocs # Or equivalent with the package manager of your choice |
There was a problem hiding this comment.
Why do we need to install mkdocs when it is already specified in pyproject.toml
There was a problem hiding this comment.
I agree.
I directly started at https://github.com/pdm-project/pdm/blob/main/CONTRIBUTING.md#preview-the-documentation which threw me the mkdocs problem.
I later ran into too many other missing things at which point I realized I missed https://github.com/pdm-project/pdm/blob/main/CONTRIBUTING.md#local-development.
I read pyproject.toml. Removed this mkdocs requirement now.
Please check
… from CONTRIBUTING.md
Pull Request Checklist
news/describing what is new.Describe what you have changed in this PR.
I was not able to setup shell completion in my 'Bash' shell until I ran into python-poetry/poetry#2295
My submission is a solution that worked without any issues for me