Skip to content
This repository was archived by the owner on Jun 30, 2024. It is now read-only.

Commit 7ab0951

Browse files
committed
Docs: Correct / clarify when to run poetry_fix.
1 parent f27e351 commit 7ab0951

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# See the `Poetry docs <https://python-poetry.org/docs/dependency-specification/>`_ to get an understanding of
55
# how poetry specifies dependencies.
66
#
7-
# **Important**: Before running ``poetry install`` or ``poetry update``, run ``python runestone/poetry_fix.py`` so that development dependencies will be installed correctly.
7+
# **Important**: This program performs automated edits to the ``pyproject.toml`` files for this project and all its subprojects (such as the BookServer and the Runestone Components) specified by `path dependencies <https://python-poetry.org/docs/dependency-specification/#path-dependencies>`_. Therefore, you **must** run ``python runestone/poetry_fix.py`` after making any changes to this file or any ``pyproject.toml`` `path dependencies`_ to keep these files up to date.
88
#
99
# .. toctree::
1010
# :maxdepth: 2

0 commit comments

Comments
 (0)