Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

export goal py_hermetic_scripts option docs have misrendered list #20893

Closed
huonw opened this issue May 9, 2024 · 0 comments · Fixed by #20903
Closed

export goal py_hermetic_scripts option docs have misrendered list #20893

huonw opened this issue May 9, 2024 · 0 comments · Fixed by #20903
Assignees
@huonw
Labels
bug category:documentation documentation
Milestone
2.21.x

Comments

@huonw
Copy link
Contributor

huonw commented May 9, 2024

Describe the bug

There's a minor formatting defect in the docs for https://www.pantsbuild.org/2.21/reference/goals/export#py_hermetic_scripts

image

The - -E is intended to be a new list item.

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

Lines 110 to 111 in 2505e54

- `-s` skips inclusion of the user site-packages directoy,
- `-E` ignores all `PYTHON*` env vars like `PYTHONPATH`.

(While we're at it, we could potentially also switch 'mutable_virtualenv' ('symlinked_immutable_virtualenv' to use backticks and thus get code-formatting?)

Pants version

2.21

OS

N/A

Additional info
N/A
@huonw huonw added this to the 2.21.x milestone May 9, 2024
@huonw huonw self-assigned this May 10, 2024
@huonw huonw mentioned this issue May 10, 2024
Merged
huonw added a commit that referenced this issue May 10, 2024
@huonw
Adjust docs for python export goal option (#20903)
4209a9d 
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
WorkerPants pushed a commit that referenced this issue May 10, 2024
@huonw @WorkerPants
Adjust docs for python export goal option (#20903)
73b0a95 
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
@WorkerPants WorkerPants mentioned this issue May 10, 2024
Merged
huonw added a commit that referenced this issue May 10, 2024
@WorkerPants @huonw
Adjust docs for python export goal option (Cherry-pick of #20903) (#…
42fdbbd 
…20904)

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

Co-authored-by: Huon Wilson <huon@exoflare.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@huonw huonw

Labels
bug category:documentation documentation
Projects
None yet
Milestone
2.21.x
Development

Successfully merging a pull request may close this issue.

Adjust docs for python export goal option pantsbuild/pants
1 participant
@huonw