2.0: Remove the now-unused `@requires` JSDoc tag from reference

[nbogie]

Increasing access

Removing the now-unused @requires JSDoc tag simplifies the documentation, allowing more people to comprehend and contribute to it.

Most appropriate sub-area of p5.js?

• Accessibility
• Color
• Core/Environment/Rendering
• Data
• DOM
• Events
• Image
• IO
• Math
• Typography
• Utilities
• WebGL
• Build process
• Unit testing
• Internationalization
• Friendly errors
• Other (specify if possible)

Feature enhancement details

See conversation confirming it can be removed.

The guide https://beta.p5js.org/contribute/contributing_to_the_p5js_reference/ should also be updated correspondingly.

testing

As this is a sweeping change, I suggest it'll be important to think carefully on testing the generated artifacts before and after (those being, at least reference website, type declarations, FES parameter data, data.json for export).

Making the actual change is the easy bit!

I'm happy to support (or do it myself).

[ksen0]

Thanks! I think it's ok to work on this! Only caveat is that if there's an RC for 2.x out when this PR is done, then we should either merge after the current patch is published (right now the patch is mostly docs and some small fixes), or make sure to give adequate time for testing (~a week generally, with reminders to ask for tests). I was just looking at the recent commits and was going to make an RC for 2.2.3 )(and next 1.x patch) so that the new reference contributor docs can be accurate. They both link to the website, and the website is source of truth, but the website is only updated upon release.

[nbogie]

Ok, thank you, I will take it.

No particular hurry for this change, so it can wait for a quieter period, I think.

[ksen0]

@nbogie bumping this up the queue now - it would be a good time to make these kinds of updates to 2.x now/soon as we'll be nearing 2.3 RC

[ksen0]

Related PR is closed