update the model params to be correct for 2.0 in docs and FES#7832
update the model params to be correct for 2.0 in docs and FES#7832ksen0 merged 1 commit intoprocessing:dev-2.0from
Conversation
| * @method model | ||
| * @param {p5.Geometry} model 3D shape to be drawn. | ||
| * | ||
| * @param {Number} count number of instances to draw. |
There was a problem hiding this comment.
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] ...
There was a problem hiding this comment.
Good point, thanks! I'm on my phone right now but I'll add it later on
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
@davepagurek truly agree here with you as per above comment. Saying as per the changes done in #7824
4 participants
Resolves #7831
Changes:
I have updated the parameter data in
parameterData.jsonandloading.jsto reflect the addition of an instance count.PR Checklist
npm run lintpasses