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

[JS] Ship (synchronous) Iterator Helpers #35698

Open
8 tasks done
Tracked by #574
Rumyra opened this issue Sep 2, 2024 · 6 comments
Open
8 tasks done
Tracked by #574

[JS] Ship (synchronous) Iterator Helpers #35698

Rumyra opened this issue Sep 2, 2024 · 6 comments
Assignees
Labels

Comments

@Rumyra
Copy link
Collaborator

Rumyra commented Sep 2, 2024

Acceptance criteria

  • The listed features are documented sufficiently on MDN
  • BCD is updated
  • Interactive example and data repos are updated if appropriate
  • The content has been reviewed as needed

For folks helping with Firefox related documentation

  • Set bugs to dev-doc-complete
  • Add entry to Firefox release notes for enabled/preview features
  • Add/remove entry to Firefox experimental features page for preference/released features

Related Gecko bugs

https://bugzilla.mozilla.org/show_bug.cgi?id=1896390

Other

  • Check content open issues to see if any pertain to the subject matter. If there are any that can be closed because of the work, do so. If there are any that can be fixed relatively quickly because of the knowledge from completing this issue and you have time, feel free to go ahead and fix them.
@github-actions github-actions bot added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Sep 2, 2024
@Rumyra Rumyra added Firefox 131 Content:JS JavaScript docs and removed needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. labels Sep 2, 2024
@Rumyra Rumyra added this to the Firefox 131: Due Oct 1st milestone Sep 3, 2024
@hamishwillee hamishwillee self-assigned this Sep 17, 2024
@hamishwillee
Copy link
Collaborator

hamishwillee commented Sep 17, 2024

Status

@Josh-Cena
Copy link
Member

iterator helper section on Iterator page - e.g. reduce() is described on that page but not linked from it (while drop() does link.

Sorry, not sure what you mean? You mean that the drop() page has a link to "Iterator helper"? This is because of the following:

Among these methods, filter(), flatMap(), map(), drop(), and take() return a new Iterator Helper object. The iterator helper is also an Iterator instance, making the helper methods chainable

Only these methods return an "Iterator helper" object. Other methods can be called "Iterator helper" methods, but the term "Iterator helper" itself is not necessary to explain their behavior.

@hamishwillee
Copy link
Collaborator

@Josh-Cena Yes, that is what I meant. If you look at https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Iterator#iterator_helpers it reads as a topic on "Iterator helpers" not "the iterator helper object".
It uses reduce() as the example of what iterator helpers are for.

So my argument here was that this would be a useful link from reduce() and the other iterator helper methods, whether or not they return Iterator helper objects.

I quite like the idea of this topic on the helper rather than helper-object focus because it allows me to understand why they are useful.

@Josh-Cena
Copy link
Member

Well I have no opinions about doing that. If you want to mention "iterator helper method" in the description, sure.

@hamishwillee
Copy link
Collaborator

Thanks. I think it would be as a See also link from all the methods. But if you're unconvinced, I'm not pushing it.

@Josh-Cena
Copy link
Member

Sounds good to me 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 participants