Skip to content

Commit

Permalink
remove custom notation
Browse files Browse the repository at this point in the history
  • Loading branch information
DanielYang59 committed Sep 17, 2024
1 parent e447010 commit 5eab47f
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions docs/userguide/datafiles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -360,25 +360,24 @@ Meanwhile, to further clarify the interplay between these three keywords,
to include certain data file into the source distribution, the following
logic condition has to be met::

m or (p and not e)
MANIFEST.in or (package-data and not exclude-package-data)

In plain language, the file should be either: 1. included in ``MANIFEST.in``;
or 2. selected by ``package-data`` AND not excluded by ``exclude-package-data``.
In plain language, the file should be either:

1. included in ``MANIFEST.in``; or

2. selected by ``package-data`` AND not excluded by ``exclude-package-data``.

To include some data file into the ``.whl``::

(not e) and ((i and m) or p)
(not exclude-package-data) and ((include-package-data and MANIFEST.in) or package-data)

In plain language, the file should not be excluded by ``exclude-package-data``
(highest priority), and should be either: 1. selected by ``package-data``; or
2. selected by ``MANIFEST.in`` AND use ``include-package-data = true``.
In other words, the file should not be excluded by ``exclude-package-data``
(highest priority), AND should be either:

**Notation**::
1. selected by ``package-data``; or

i - "include-package-data = true" is set
e - file selected by "exclude-package-data"
p - file selected by "package-data"
m - file included in "MANIFEST.in"
2. selected by ``MANIFEST.in`` AND use ``include-package-data = true``.

Summary
-------
Expand Down

0 comments on commit 5eab47f

Please sign in to comment.