Skip to content

Clarify documentation for forEach()#861

Open
bennorth wants to merge 1 commit intoStuk:mainfrom
bennorth:clarify-forEach-doc
Open

Clarify documentation for forEach()#861
bennorth wants to merge 1 commit intoStuk:mainfrom
bennorth:clarify-forEach-doc

Conversation

@bennorth
Copy link
Copy Markdown

@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