Skip to content

remove unused @requires from all jsdoc#8713

Open
nbogie wants to merge 2 commits intoprocessing:dev-2.0from
nbogie:nb-remove-requires-jsdoc
Open

remove unused @requires from all jsdoc#8713
nbogie wants to merge 2 commits intoprocessing:dev-2.0from
nbogie:nb-remove-requires-jsdoc

Conversation

@nbogie
Copy link
Copy Markdown
Contributor

@nbogie nbogie commented Apr 8, 2026

Resolves #8628

Changes:

changes

  • removes all @requires lines from jsdoc under src/
  • removes mention of that tag from the reference guide

testing

  • npm run docs runs ok.

  • p5.js-website reference generation: runs and presents ok

  • generated type declarations and parameterData.json all look ok (contents are the same except ordering has changed).

  • npm run test:types passes

note: comparing two versions of parameterData.json by first sorting all arrays can be done like this (assuming the jq utility is installed):

diff <(jq -S 'walk(if type == "array" then sort else . end)' file1.json) \
     <(jq -S 'walk(if type == "array" then sort else . end)' file2.json) 

misc notes

remove with find + sed:

find src -type f \( -name "*.js" -o -name "*.ts" \) -exec sed -i '' '/^[[:space:]]*\*[[:space:]]*@requires/d' {} +

...then visually inspect changes with git diff

PR Checklist

  • npm run lint passes
  • [Inline reference] is included / updated
  • [Unit tests] are included / updated - three visual tests fail (same before and after)

@nbogie nbogie marked this pull request as ready for review April 8, 2026 13:41
@nbogie
Copy link
Copy Markdown
Contributor Author

nbogie commented Apr 8, 2026

tested website generation too, now. (was blocked by #1321)

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