Skip to content

Commit 28910e1

Browse files
committed
docs: reword based on @di's suggestion
1 parent 13cb1ba commit 28910e1

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

source/tutorials/packaging-projects.rst

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -98,12 +98,16 @@ below. See :pep:`517` and :pep:`518` for background and details.
9898
Configuring metadata
9999
--------------------
100100

101-
You can place the metadata for your project in one of two places. Static
102-
information should be placed in :file:`setup.cfg`. This is simpler, easier to
103-
read, and avoids many common errors, like encoding errors. Any items that are
104-
dynamic, as well as extension modules or extensions to setuptools, need to go
105-
into :file:`setup.py`. You can completely configure via :file:`setup.py` if you
106-
really want to; both methods are shown below.
101+
There are two types of metadata: static and dynamic.
102+
103+
* Static metadata (:file:`setup.cfg`): guaranteed to be the same every time. This is
104+
simpler, easier to read, and avoids many common errors, like encoding errors.
105+
* Dynamic metadata (:file:`setup.py`): possibly non-deterministic. Any items that are
106+
dynamic or determined at install-time, as well as extension modules or
107+
extensions to setuptools, need to go into :file:`setup.py`.
108+
109+
Static metadata should be preferred and dynamic metadata should be used only as
110+
an escape hatch when absolutely necessary.
107111

108112
.. tabs::
109113

0 commit comments

Comments
 (0)