Skip to content
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.

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

[documentation] Documentation of "last" parameter default doesn't match code #65

Closed
kepstin opened this issue Jan 16, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@kepstin
Copy link

kepstin commented Jan 16, 2023

In the current version of the README, the last option is documented as having a default of true:

Property Type Default Description
last boolean true Whether the stroke is complete.

However, in the code - getStrokeOutlinePoints and getStrokePoints - the actual default of the last option (assigned to the isComplete variable) is set to false.

I'm not sure what the intention is here, but to preserve the behaviour of the library it might be best to leave the default as false and update the documentation to match.

@kepstin kepstin added the documentation Improvements or additions to documentation label Jan 16, 2023
@steveruizok
Copy link
Owner

steveruizok commented May 6, 2023

Fixed! Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants