fix: inaccurate Python instructions #74
Merged
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.
Overview
Fixed order and description of instructions for "Testing" "via Python".
Changes
pip install poetry
to its own grouppoetry install
beforepoetry shell
Notes
The
poetry install
andpoetry shell
commands both activate a Poetry-managed virtual environment, which is helpful to avoid dependency conflicts for users who do not use virtual environments to isolate their projects.The
poetry install
installs project dependencies within the current virtual environment. Thepython shell
allows running commands for installed dependencies e.g.mkdocs
within the current virtual environment.If
poetry install
has not been run yet, thenpoetry shell
would not offermkdocs
. Whenmkdocs
is unavailable, user response may be to installmkdocs
. Installingmkdocs
, while in this state, can cause different problems depending on how it is done.pip install mkdocs
would install latest version, not project version.poetry install
(…
) would fail.1Footnotes
Because
poetry
is not installed within the virtual environment, becausepoetry
is not a dependency of the project itself. ↩