Skip to content

Commit eb7631a

Browse files
committed
README: add use case for write_to
Ref: #273 (comment) [ci skip]
1 parent 873f065 commit eb7631a

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -176,8 +176,9 @@ The currently supported configuration keys are:
176176

177177
:write_to:
178178
A path to a file that gets replaced with a file containing the current
179-
version.
180-
It is ideal for creating a version.py file within the package.
179+
version. It is ideal for creating a version.py file within the package,
180+
typically used to avoid using `pkg_resources.get_distribution` (which adds
181+
some overhead).
181182

182183
.. warning::
183184

0 commit comments

Comments
 (0)