Skip to content

Commit 5ea21e5

Browse files
committed
Add '.txt' extension to examples of tool.setuptools.dynamic.readme.file
This prevents misunderstandings and incorrect assumptions that the extension is implicitly derived.
1 parent b545fc7 commit 5ea21e5

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/userguide/pyproject_config.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ Key Directive Notes
192192
``version`` ``attr``, ``file``
193193
``readme`` ``file`` Here you can also set ``"content-type"``:
194194

195-
``readme = {file = ["README", "USAGE"], content-type = "text/plain"}``
195+
``readme = {file = ["README.txt", "USAGE.txt"], content-type = "text/plain"}``
196196

197197
If ``content-type`` is not given, ``"text/x-rst"`` is used by default.
198198
``description`` ``file`` One-line text (no line breaks)

0 commit comments

Comments
 (0)