Merge pull request #10795 from bluthej/fix-10782

Fix example in the documentation (#10782)
This commit is contained in:
Bruno Oliveira 2023-03-05 13:49:35 -03:00 committed by GitHub
commit 5f47e423b2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 1 deletions

1
changelog/10782.doc.rst Normal file
View File

@ -0,0 +1 @@
Fixed the minimal example in :ref:`goodpractices`: ``pip install -e .`` requires a ``version`` entry in ``pyproject.toml`` to run successfully.

View File

@ -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: