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 incomplete for scan #232

Open
jordanbtucker opened this issue Feb 20, 2022 · 0 comments
Open

Documentation incomplete for scan #232

jordanbtucker opened this issue Feb 20, 2022 · 0 comments

Comments

@jordanbtucker
Copy link

jordanbtucker commented Feb 20, 2022

(Thanks for reporting an issue to micromatch! If you haven't already read the contributor guidelines, Please do that now, then proceed to fill out the details below.)

Please describe the minimum necessary steps to reproduce this issue:

This is a documentation issue.

What is happening that shouldn't be?

The documentation for the scan method says "Returns an object with" and then cuts off. It also references a split method that doesn't seem to exist.

What should be happening instead?

The documentation should be fixed. Perhaps the example should also be expanded to better explain the purpose of scan.

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

No branches or pull requests

2 participants