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

Text in angle brackets needs to be escaped for the docsite. #15046

Merged
merged 1 commit into from Apr 7, 2022

Conversation

kaos
Copy link
Member

@kaos kaos commented Apr 7, 2022

This fixes an issue with the docs, that look like this:
image

@kaos
Copy link
Member Author

kaos commented Apr 7, 2022

Fixed example:
image

@kaos kaos requested a review from Eric-Arellano April 7, 2022 14:10
Copy link
Member

@jsirois jsirois left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Presumably the right way to prevent whac-a-mole is to do wholistic HTML escaping in the code that generates these pages.

Copy link
Contributor

@Eric-Arellano Eric-Arellano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops! Thank you so much for fixing this.

Would be good to cherry pick if you are willing

@kaos
Copy link
Member Author

kaos commented Apr 7, 2022

Presumably the right way to prevent whac-a-mole is to do wholistic HTML escaping in the code that generates these pages.

That would be more robust, yes. I'll leave that as a future todo.

@kaos kaos merged commit 39fee2d into pantsbuild:main Apr 7, 2022
@kaos kaos deleted the doc_typos branch April 7, 2022 15:08
@kaos
Copy link
Member Author

kaos commented Apr 7, 2022

Oh, it seems that NOT doing html escaping is by design:

As it uses {{{ help }}} rather than {{ help }}..

@jsirois
Copy link
Member

jsirois commented Apr 7, 2022

Aha. OK then.

Copy link
Sponsor Contributor

@benjyw benjyw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

kaos added a commit to kaos/pants that referenced this pull request Apr 7, 2022
kaos added a commit that referenced this pull request Apr 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants