Model params updated for YUIDocs #7835
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 tasks
There was a problem hiding this comment.
Pull Request Overview
This PR updates the YUIDocs for the model() method to indicate that the count parameter is now optional with a default value of 1.
- Updated the JSDoc for the model() method to reflect the optional count parameter.
- Modified the parameter description to show the default value [count=1].
davepagurek
reviewed
May 21, 2025
| @@ -987,7 +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. | |||
| * @param {Number} [count=1] number of instances to draw. | |||
There was a problem hiding this comment.
This looks good! Mind running npm run docs and committing the results to double check that parameterData.json looks good when generated from this?
There was a problem hiding this comment.
Ah right, yeah now its good. I changed the parameterData.json by hand before. It's not truly an overload, just an optional parameter.
There was a problem hiding this comment.
ahh! I see the changes in the PR #7824 got worked perfectly fine here @davepagurek and @lukeplowden
davepagurek
approved these changes
May 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes:
Amending #7832 to make the YUIDocs for
model()count parameter optional.PR Checklist
npm run lintpasses