From 5a61ec3d4a7495e65686b35617e3277ec44b6213 Mon Sep 17 00:00:00 2001 From: bluthej Date: Sun, 5 Mar 2023 16:42:05 +0100 Subject: [PATCH] Fix example in the documentation (#10782) --- changelog/10782.doc.rst | 1 + doc/en/explanation/goodpractices.rst | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) create mode 100644 changelog/10782.doc.rst diff --git a/changelog/10782.doc.rst b/changelog/10782.doc.rst new file mode 100644 index 000000000..c2bd4af8c --- /dev/null +++ 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 index 98b4b56eb..7331a7896 100644 --- 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: