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

P2HDR docs #7728

Open
wants to merge 2 commits into
base: dev-2.0
Choose a base branch
from
Open

P2HDR docs #7728

wants to merge 2 commits into from

Conversation

perminder-17
Copy link
Contributor

@perminder-17 perminder-17 commented Apr 12, 2025

No description provided.

@perminder-17
Copy link
Contributor Author

Looks like tests aren't passing, will look into it.

* @typedef {unique symbol} P2D
* The default, two-dimensional renderer in p5.js.
*
* Use this when calling {@link p5.createCanvas|createCanvas} (for example,
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure that we support @link yet, this is the result of npm run docs:
image

It looks like we don't use this syntax elsewhere in the codebase currently, could we keep using the old <a href="#/p5/createCanvas"> for consistency?

* @property {P2D} P2D
* @final
*/
export const P2D = 'p2d';

export const P2DHDR = 'p2d-hdr';
Copy link
Contributor

Choose a reason for hiding this comment

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

I think you'll need to add this line back after your comment block to fix the tests -- looks like the error is that this constant is no longer defined.

@perminder-17
Copy link
Contributor Author

Sure @davepagurek , sorry for the oversight.

@davepagurek
Copy link
Contributor

No worries! @link is part of the jsdoc spec so it's not obvious that it wouldn't be supported.

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.

2 participants