Update saveFrames documentation
#5694
Merged
Conversation
This file contains 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
|
🎉 Thanks for opening this pull request! Please check out our contributing guidelines if you haven't already. And be sure to add yourself to the list of contributors on the readme page! |
src/image/image.js
Outdated
| @@ -420,15 +420,20 @@ p5.prototype.saveGif = function(pImg, filename) { | |||
| * as an argument to the callback function as an array of objects, with the | |||
| * size of array equal to the total number of frames. | |||
| * | |||
| * Note that <a href="#/p5.Image/saveFrames">saveFrames()</a> will only save the first 15 frames of an animation. | |||
| * Note that <a href="#/p5.Image/saveFrames">saveFrames()</a> will only save the first 15 seconds of an animation. | |||
There was a problem hiding this comment.
I don't think we need this line anymore with the explanations below.
There was a problem hiding this comment.
@jesi-rgb Still have this pending then we can merge.
There was a problem hiding this comment.
Got it and also a minor typo!
limzykenneth
requested changes
Jun 20, 2022
|
Seems like this is already working fine! It let me commit with the correct configuration! |
17 tasks
|
Looks good. Thanks! |
1 task
1 task
1 task
This was referenced Nov 20, 2022
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.
Issue
Resolves #5685, in which some discussion was made regarding the behaviour of the
saveFramesfunction. @endurance21 and I were inspecting the code and thought it was not working properly, but @limzykenneth went ahead and clarified why the arguments are set up like that, but stated that there was no proper explanation for that within the docs. So that is what this change is aiming to solve!I tried to be explicit enough in my explanation for the reason to be clear, but not too technical so newcomers can properly understand the problem. Let me know if I it needs change for it to be either clearer and more explicit or less technical and more friendly!
Changes
3. Adds further explanation as to why the function works like this
5. Adds further explanation in the arguments description to make sure people know what to expect.
Screenshots of the change:
The changes I added are highlighted.
PR Checklist
npm run lintpasses