Update docs site for version 2.23.0.dev4 #234
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WorkerPants
added
the
automation:sync-docs
huonw
reviewed
Jul 25, 2024
| @@ -61,12 +61,21 @@ If you instead want those files included in any packages specified in the `packa | |||
|
|
|||
| <Field | |||
| type_repr={`str | None`} | |||
| default_repr={`None`} | |||
| default_repr={`'${spec_path_normalized}/${target_name_normalized}${file_suffix}'`} | |||
There was a problem hiding this comment.
I suspect this is causing the build failures, we'll need to do more escaping.
There was a problem hiding this comment.
With #235, this now looks like:
@@ -61,7 +61,7 @@ If you instead want those files included in any packages specified in the `packa
<Field
type_repr={`str | None`}
- default_repr={`'${spec_path_normalized}/${target_name_normalized}${file_suffix}'`}
+ default_repr={`'\${spec_path_normalized}/\${target_name_normalized}\${file_suffix}'`}
>
Where the built asset should be located.And renders "properly":
|
Closing. I'll recreate once #235 is in. |
huonw
added a commit
that referenced
this pull request
Jul 25, 2024
This escapes `$` in default values to avoid them being treated as
template literal substitutions.
Default values end up in a template literal `` `something` ``. If the
string contains `${...}` literally, they'll be treated as a
substitution. This PR escapes all `$`s to avoid this.
This bug/oversight doesn't cause problems with any _current_ values, but
will be required in 2.23.0.dev4 due to the new default value for
`output_path` fields from
pantsbuild/pants#21175.
Example of the effect (from
#234 (comment)):
```diff
- default_repr={`'${spec_path_normalized}/${target_name_normalized}${file_suffix}'`}
+ default_repr={`'\${spec_path_normalized}/\${target_name_normalized}\${file_suffix}'`}
```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docs from https://github.com/pantsbuild/pants/releases/tag/release_2.23.0.dev4