Merge pull request #10795 from bluthej/fix-10782

Fix example in the documentation (#10782)
pytest-dev · Mar 5, 2023 · 5f47e42 · 5f47e42
2 parents b3b44ea + 5a61ec3
commit 5f47e42
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/changelog/10782.doc.rst b/changelog/10782.doc.rst
@@ -0,0 +1 @@
+Fixed the minimal example in :ref:`goodpractices`: ``pip install -e .`` requires a ``version`` entry in ``pyproject.toml`` to run successfully.
diff --git a/doc/en/explanation/goodpractices.rst b/doc/en/explanation/goodpractices.rst
@@ -24,8 +24,9 @@ The first few lines should look like this:
 
     [project]
     name = "PACKAGENAME"
+    version = "PACKAGEVERSION"
 
-where ``PACKAGENAME`` is the name of your package.
+where ``PACKAGENAME`` and ``PACKAGEVERSION`` are the name and version of your package respectively.
 
 You can then install your package in "editable" mode by running from the same directory: