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

Normalized Set format and clarified set vs array #3342

Merged
merged 5 commits into from
Apr 2, 2021
Merged

Normalized Set format and clarified set vs array #3342

merged 5 commits into from
Apr 2, 2021

Conversation

RIAEvangelist
Copy link
Contributor

@RIAEvangelist RIAEvangelist commented Mar 22, 2021

I was reading the docs on this today and was very confused by how and why the docs were doing things. After spending some time testing the examples, I realized that they simply were not consistent in how they were written and were type casting in someplace for no reason. These changes settle on representing the Set according to the standard unless explicitly showing how to convert from a set to an array.

This should help devs not already familiar with Set to better understand it and its uniqueness at first glance and reduce confusion like I had by utilizing the standards for Set when applicable

Checklist — To help your pull request get merged faster, please do the following:

    • Provide a summary of your changes — say what problem you are fixing, what files are changed, and what you've done. This doesn't need to be hugely detailed, as we can see exact changes in the "Files changed" tab.
    • Provide a link to the issue(s) you are fixing, if appropriate, in the form "Fixes url-of-issue". GitHub will render this in the form "Fixes fix: fixable flaws in Glossary A-D entries #1234", with the issue number linked to the issue. Doing this allows us to figure out what issues you are fixing, as well as helping to automate things (for example the issue will be closed once the PR that fixed it has been merged).
    • Review the results of the automated checking we run on every PR and fix any problems reported (see the list of checks near the bottom of the PR page). If you need help, please ask in a comment!
    • Link to any other resources that you think might be useful in reviewing your PR.

I was reading the docs on this today and was very confused by how and why the docs were doing things. After spending some time testing the examples, I realized that they simply were not consistent in how they were written and were type casting in someplace for no reason. These changes settle on representing the `Set` according to the standard unless explicitly showing how to convert from a set to an array.

This should help devs not already familiar with Set to better understand it and its uniqueness at first glance and reduce confusion like I had by utilizing the standards for Set when applicable
@RIAEvangelist RIAEvangelist requested a review from a team as a code owner March 22, 2021 00:34
@RIAEvangelist RIAEvangelist requested review from Rumyra and removed request for a team March 22, 2021 00:34
Copy link

@MaybeRex MaybeRex left a comment

Choose a reason for hiding this comment

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

Screen Shot 2021-03-22 at 11 44 49 AM

Copy link
Collaborator

@Rumyra Rumyra left a comment

Choose a reason for hiding this comment

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

Thanks so much @RIAEvangelist

Please see the review comments ☺️

@RIAEvangelist
Copy link
Contributor Author

Apologies, I had to go to Florida for a funeral. Will review the suggested edits.

RIAEvangelist and others added 4 commits March 31, 2021 13:13
…html

Co-authored-by: Ruth John <Rumyra@users.noreply.github.com>
…html

Co-authored-by: Ruth John <Rumyra@users.noreply.github.com>
…html

Co-authored-by: Ruth John <Rumyra@users.noreply.github.com>
…html


added 'Set' to the returns comment for the Set object to increase accuracy.

Co-authored-by: Ruth John <Rumyra@users.noreply.github.com>
Copy link
Contributor Author

@RIAEvangelist RIAEvangelist left a comment

Choose a reason for hiding this comment

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

Merged all suggestions in, I see why they are relevant and useful. Thanks!

@Rumyra
Copy link
Collaborator

Rumyra commented Apr 2, 2021

Thank you so much @RIAEvangelist 🎉

@Rumyra Rumyra merged commit c42afa5 into mdn:main Apr 2, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 19, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants