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

Clarify documentation for forEach() #861

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bennorth
Copy link

@bennorth bennorth commented Sep 4, 2022

Thanks very much for jszip; it's very useful. This minor suggestion clarifies the summary docstring for the forEach() method. The example in the docs is clear as to the recursive/descending behaviour of forEach(), but I think the current summary could be seen as ambiguous. Thanks!

(I didn't change the occurrence in dist/jszip.js as it looks like it's a generated file. If I've misunderstood, please comment and I'll update this PR.)

Saying "at" this folder level could be taken as meaning *exactly* at
that level, i.e., not descending into subfolders.  The forEach()
method does in fact descend, so say "at or below".
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant