Skip to content

Unescape < and > in inline code in docs#8661

Open
davepagurek wants to merge 1 commit intodev-2.0from
unescape
Open

Unescape < and > in inline code in docs#8661
davepagurek wants to merge 1 commit intodev-2.0from
unescape

Conversation

@davepagurek
Copy link
Contributor

Related to processing/p5.js-website#1240. Part of the problem there was that some inline code in the reference was manually unescaped in the p5 source code, while others were not. This led to us having to try to figure out which to escape or which not to. It's probably easier for everyone if it's consistent: never manually escape in docs.

This was generated by:

  • Running find src -name "*.js" | xargs perl -p -i -e 's/&lt;/</g'
  • Running find src -name "*.js" | xargs perl -p -i -e 's/&gt;/>/g'
  • Manually correcting the one false positive in the diff, a function escapeHelper that maps raw symbols to escaped versions
  • Tested in the p5.js-website repo using npm run custom:dev https://github.com/processing/p5.js.git#unescape

Changes:

  • Instances of manual &lt; and &gt; in the docs are replaced by < and >

Screenshots of the change:
image

PR Checklist

@davepagurek davepagurek requested a review from ksen0 March 20, 2026 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant