Skip to content

Commit 4209a9d

Browse files
authored
Adjust docs for python export goal option (#20903)
This makes a few minor adjustments to the docs for the `py_editable_in_resolve` and `py_hermetic_scripts` options to `pants export ...`: - add some indentation so that `softwrap` preserves the crucial newlines in a Markdown list - backticks around more things for code formatting - minor typo Fixes #20893
1 parent a3eaf70 commit 4209a9d

File tree

1 file changed

+9
-9
lines changed
  • src/python/pants/backend/python/goals

1 file changed

+9
-9
lines changed

src/python/pants/backend/python/goals/export.py

+9-9
Original file line numberDiff line numberDiff line change
@@ -84,16 +84,16 @@ class ExportPluginOptions:
8484
help=softwrap(
8585
"""
8686
When exporting a mutable virtualenv for a resolve, do PEP-660 editable installs
87-
of all 'python_distribution' targets that own code in the exported resolve.
87+
of all `python_distribution` targets that own code in the exported resolve.
8888
89-
If a resolve name is not in this list, 'python_distribution' targets will not
89+
If a resolve name is not in this list, `python_distribution` targets will not
9090
be installed in the virtualenv. This defaults to an empty list for backwards
9191
compatibility and to prevent unnecessary work to generate and install the
9292
PEP-660 editable wheels.
9393
94-
This only applies when '[python].enable_resolves' is true and when exporting a
95-
'mutable_virtualenv' ('symlinked_immutable_virtualenv' exports are not "full"
96-
virtualenvs because they must not be edited, and do not include 'pip').
94+
This only applies when `[python].enable_resolves` is true and when exporting a
95+
`mutable_virtualenv` (`symlinked_immutable_virtualenv` exports are not "full"
96+
virtualenvs because they must not be edited, and do not include `pip`).
9797
"""
9898
),
9999
advanced=True,
@@ -107,16 +107,16 @@ class ExportPluginOptions:
107107
modify console script shebang lines to make them "hermetic".
108108
The shebang of hermetic console scripts uses the python args: `-sE`:
109109
110-
- `-s` skips inclusion of the user site-packages directoy,
111-
- `-E` ignores all `PYTHON*` env vars like `PYTHONPATH`.
110+
- `-s` skips inclusion of the user site-packages directory,
111+
- `-E` ignores all `PYTHON*` env vars like `PYTHONPATH`.
112112
113113
Set this to false if you need non-hermetic scripts with
114114
simple python shebangs that respect vars like `PYTHONPATH`,
115115
to, for example, allow IDEs like PyCharm to inject its debugger,
116116
coverage, or other IDE-specific libs when running a script.
117117
118-
This only applies when when exporting a 'mutable_virtualenv'
119-
('symlinked_immutable_virtualenv' exports are not "full"
118+
This only applies when when exporting a `mutable_virtualenv`
119+
(`symlinked_immutable_virtualenv` exports are not "full"
120120
virtualenvs because they are used internally by pants itself.
121121
Pants requires hermetic scripts to provide its reproduciblity
122122
guarantee, fine-grained caching, and other features).

0 commit comments

Comments
 (0)