X Tutup
Skip to content

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

@nbogie

Description

@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).

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      X Tutup