Fix: Correct missing comma and grammar errors in README examples - #9
Open
mara218 wants to merge 2 commits into
Open
Fix: Correct missing comma and grammar errors in README examples#9mara218 wants to merge 2 commits into
mara218 wants to merge 2 commits into
Conversation
Fix: Add missing comma in README example
Fix: Correct grammar in README for start() method instructions
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR fixes two documentation issues in the README:
Missing comma in example code
The
outlineColorline in the optional parameters example was missing a trailing comma:Incorrect:
outlineColor: 'rgba(255, 255, 255, 0.5)' // (Optional)
Corrected:
outlineColor: 'rgba(255, 255, 255, 0.5)', // (Optional)
Without this comma, the example produces invalid JavaScript when copied by users.
Grammar fix in method usage instructions
The sentence "The call start to start the animation." was replaced with:
"Call the
start()method to begin the animation."These fixes improve clarity and correctness for users following the documentation.