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.

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

Adjust docs for python export goal option #20903

Merged
merged 3 commits into from
May 10, 2024
Merged

Conversation

huonw
Copy link
Contributor

@huonw huonw commented May 10, 2024

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

image

@huonw huonw added this to the 2.21.x milestone May 10, 2024
@huonw huonw marked this pull request as ready for review May 10, 2024 06:59
@huonw huonw requested review from kaos and cognifloyd May 10, 2024 07:00
@huonw huonw merged commit 4209a9d into main May 10, 2024
25 checks passed
@huonw huonw deleted the huonw/20893-hermetic-docs branch May 10, 2024 08:30
WorkerPants pushed a commit that referenced this pull request May 10, 2024
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
Copy link
Member

I tried to automatically cherry-pick this change back to each relevant milestone, so that it is available in those older releases of Pants.

✔️ 2.21.x

Successfully opened #20904.


Thanks again for your contributions!

🤖 Beep Boop here's my run link

huonw added a commit that referenced this pull request May 10, 2024
…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
Labels
category:documentation release-notes:not-required PR doesn't require mention in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

export goal py_hermetic_scripts option docs have misrendered list
4 participants