p5.js-website icon indicating copy to clipboard operation
p5.js-website copied to clipboard

Object properties showing up in parameter list in reference pages

Open davepagurek opened this issue 8 months ago • 4 comments

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 avatar Apr 17 '25 17:04 davepagurek

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

kajal-jotwani avatar Apr 21 '25 17:04 kajal-jotwani

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

davepagurek avatar Apr 21 '25 17:04 davepagurek

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

kajal-jotwani avatar Apr 23 '25 11:04 kajal-jotwani

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.

davepagurek avatar Apr 23 '25 19:04 davepagurek

hi, @ksen0 & @davepagurek , just to be on safe side, is this assigned to someone, or something like that?

NalinDalal avatar Jul 18 '25 04:07 NalinDalal

Hi @NalinDalal thanks for the bump - looks like @kajal-jotwani's PR needs review: https://github.com/processing/p5.js-website/pull/818 I'll take a look later today and merge if possible, but please feel free to review this one!

ksen0 avatar Jul 18 '25 05:07 ksen0

hey @ksen0 any updates?

NalinDalal avatar Jul 28 '25 07:07 NalinDalal

Hi @ksen0 @davepagurek I think the issue is fixed currently please close the issue if fixed

Iron-56 avatar Sep 08 '25 18:09 Iron-56

Thanks for following up on this @Iron-56 - yes looks like it's fixed. If it recurs, the thread can of course be reopened.

ksen0 avatar Sep 09 '25 15:09 ksen0