Skip to content

update the model params to be correct for 2.0 in docs and FES #7832

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
May 19, 2025
Merged

update the model params to be correct for 2.0 in docs and FES #7832

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/parameterData.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2741,6 +2741,10 @@
"overloads": [
[
"p5.Geometry"
],
[
"p5.Geometry",
"Number"
]
]
},
Expand Down
1 change: 1 addition & 0 deletions src/webgl/loading.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -987,6 +987,7 @@ function loading(p5, fn){
* @method model
* @param {p5.Geometry} model 3D shape to be drawn.
*
* @param {Number} count number of instances to draw.
Copy link
Contributor

Choose a reason for hiding this comment

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

Oh can we update this to be optional, so it isn't logged as an error when people call model(geom) without a count? Something like @param {Number} [count=1] ...

Copy link
Member Author

Choose a reason for hiding this comment

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

Good point, thanks! I'm on my phone right now but I'll add it later on

Copy link
Member Author

Choose a reason for hiding this comment

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

Right now, it doesn't seem to log an error anyway. Could be because the count is given a default value in the function signature? I've updated it for accuracy anyway, here is new PR

Copy link
Contributor

Choose a reason for hiding this comment

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

That makes sense with the current parameterData.json since just a p5.Geometry is a valid overload. Are the changes to parameterData.json from npm run docs or are they manual? Since we just have one overload documented here, with a required count, I'd expect the result of npm run docs to overwrite it with just a single ["p5.Geometry", "Number"] overload, which would start causing the error to be logged

Copy link
Contributor

@IIITM-Jay IIITM-Jay May 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

@davepagurek truly agree here with you as per above comment. Saying as per the changes done in #7824

* @example
* <div>
* <code>
Expand Down