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

Include null and undefined elements in flat() example #36095

Merged
merged 2 commits into from
Sep 29, 2024

Conversation

DanKaplanSES
Copy link
Contributor

Description

Include null and undefined elements in flat() examples

Motivation

  • I wasn't sure if null, undefined, and "empty" were equivalent in the eyes of the flat() method, so I tried it out in the console and learned that they are not.
  • I've modified the example for sparse arrays to include these values so that others don't have to run their own experiments to learn this information.
  • I also included a link to the sparse array documentation. If the way flat() handles null and undefined confuses the reader, I think they are likely to click on this link to educate themselves.

Additional details

Related issues and pull requests

- I wasn't sure if `null`, `undefined`, and "empty" were equivalent in the eyes of the `flat()` method, so I tried it out in the console and learned that they are not.
- I've modified the example for sparse arrays to include these values so that others don't have to run their own experiments to learn this information. 
- I also included a link to the sparse array documentation. If the way `flat()` handles `null` and `undefined` confuses the reader, I think they are likely to click on this link to educate themselves.
@DanKaplanSES DanKaplanSES requested a review from a team as a code owner September 29, 2024 00:33
@DanKaplanSES DanKaplanSES requested review from Josh-Cena and removed request for a team September 29, 2024 00:33
@github-actions github-actions bot added Content:JS JavaScript docs size/s [PR only] 6-50 LoC changed labels Sep 29, 2024
Copy link
Contributor

github-actions bot commented Sep 29, 2024

Preview URLs

(comment last updated: 2024-09-29 01:10:41)

@DanKaplanSES DanKaplanSES changed the title Include null and undefined elements in flat() examples Include null and undefined elements in flat() example Sep 29, 2024
- I noticed that a later example uses the phrase "remove empty slots" in its language, otherwise I wouldn't have made this PR: 
- I think the "ignore" in "ignore empty slots" may be more technically correct, but "remove empty slots" paints a clearer picture and is harder to misinterpret. "Ignoring" an element could have meant it is returned without modification.
Copy link
Member

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, this looks great to me!

@Josh-Cena Josh-Cena merged commit c79069d into mdn:main Sep 29, 2024
8 checks passed
fiji-flo pushed a commit that referenced this pull request Oct 2, 2024
* Include null and undefined elements in flat() examples

- I wasn't sure if `null`, `undefined`, and "empty" were equivalent in the eyes of the `flat()` method, so I tried it out in the console and learned that they are not.
- I've modified the example for sparse arrays to include these values so that others don't have to run their own experiments to learn this information. 
- I also included a link to the sparse array documentation. If the way `flat()` handles `null` and `undefined` confuses the reader, I think they are likely to click on this link to educate themselves.

* In flat() docs, change "ignore empty slots" to "remove empty slots"

- I noticed that a later example uses the phrase "remove empty slots" in its language, otherwise I wouldn't have made this PR: 
- I think the "ignore" in "ignore empty slots" may be more technically correct, but "remove empty slots" paints a clearer picture and is harder to misinterpret. "Ignoring" an element could have meant it is returned without modification.
@DanKaplanSES
Copy link
Contributor Author

Great! Thank you very much

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:JS JavaScript docs size/s [PR only] 6-50 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants