Skip to content

Object properties showing up in parameter list in reference pages #810

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

Open
davepagurek opened this issue Apr 17, 2025 · 4 comments
Open
Assignees
Labels
Bug Something isn't working Good First Issue Good for newcomers Help Wanted Extra attention is needed
Milestone

Comments

@davepagurek
Copy link
Collaborator

Most appropriate sections of the p5.js website?

Reference

What is your operating system?

Mac OS

Web browser and version

Firefox

Actual Behavior

On reference items that include objects with documented properties, e.g. https://beta.p5js.org/reference/p5.font/texttomodel/, the properties are showing up as if they're normal positional parameters:

Image

Expected Behavior

The properties should be excluded from the parameter list

Steps to reproduce

Visit https://beta.p5js.org/reference/p5.font/texttomodel/

Would you like to work on the issue?

Feel free to take this on!

@davepagurek davepagurek added Bug Something isn't working Good First Issue Good for newcomers Help Wanted Extra attention is needed labels Apr 17, 2025
@ksen0 ksen0 moved this to Ready for Work in p5.js 2.1 🌱🌳 Apr 17, 2025
@ksen0 ksen0 added this to the 2.x Anytime milestone Apr 17, 2025
@kajal-jotwani
Copy link

Hello @davepagurek, I would like to work on this issue

@davepagurek
Copy link
Collaborator Author

Thanks @kajal-jotwani! I'll assign this to you.

@kajal-jotwani
Copy link

@davepagurek I had a question do we need to completely remove the object properties from the parameters and syntax?

@davepagurek
Copy link
Collaborator Author

Sorry for the delay, I ended up leaving a similar comment on the PR. but for continuity here: I think we want to still document the properties in the section where we list the parameters by name along with their descriptions, but not show them at all in the Syntax section.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working Good First Issue Good for newcomers Help Wanted Extra attention is needed
Projects
Status: Ready for Work
Development

No branches or pull requests

3 participants