Maplike and Setlike objects in Map and Set #27160

hamishwillee · 2023-06-06T05:21:45Z

These glossary entries are designed to make it easier to talk about setlike and maplike objects, and what APIs might be present in both readonly and read/write versions.

I've listed the items I could find in both types in the appropriate entries.

I also added a comment about the IDL.

Follows on from comment in #27028 (comment)

FYI @wbamberg

github-actions · 2023-06-06T05:24:34Z

Preview URLs (14 pages)

Flaws (16)

Note! 9 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/RTCStatsReport
Title: RTCStatsReport
Flaw count: 6

macros:
- /en-US/docs/Web/API/RTCCertificateStats does not exist
- /en-US/docs/Web/API/RTCCodecStats does not exist
- /en-US/docs/Web/API/RTCDataChannelStats does not exist
- /en-US/docs/Web/API/RTCVideoSourceStats does not exist
- /en-US/docs/Web/API/RTCRemoteInboundRtpStreamStats does not exist
- and 1 more flaws omitted

URL: /en-US/docs/Web/API/Highlight
Title: Highlight
Flaw count: 1

macros:
- wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/AudioParamMap
Title: AudioParamMap
Flaw count: 6

macros:
- /en-US/docs/Web/API/AudioParamMap/size does not exist
- /en-US/docs/Web/API/AudioParamMap/entries does not exist
- /en-US/docs/Web/API/AudioParamMap/forEach does not exist
- /en-US/docs/Web/API/AudioParamMap/has does not exist
- /en-US/docs/Web/API/AudioParamMap/keys does not exist
- and 1 more flaws omitted

URL: /en-US/docs/Web/API/HighlightRegistry
Title: HighlightRegistry
Flaw count: 2

macros:
- wrong xref macro used (consider changing which macro you use)
- /en-US/docs/Web/API/CSS/highlights redirects to /en-US/docs/Web/API/CSS/highlights_static

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
Title: Set
Flaw count: 1

broken_links:
- Link points to the page it's already on

(comment last updated: 2023-06-16 15:08:29)

Josh-Cena

Casual reviews

files/en-us/glossary/maplike_object/index.md

files/en-us/glossary/setlike_object/index.md

estelle

These "definitions" are IDL definitions, not glossary terms. Glossary entries define terms. This content is better suited for /en-US/docs/Web/API/ or Web/JavaScript/Reference under the official name of the IDL/spec, with a summary in the glossary pointing to that documentation and example implementations within MDN and in the wild.

Josh-Cena · 2023-06-06T17:30:54Z

I am open to adding them as a subsection under the Map and Set pages' description section.

hamishwillee · 2023-06-06T21:49:44Z

These "definitions" are IDL definitions, not glossary terms. Glossary entries define terms. This content is better suited for /en-US/docs/Web/API/ or Web/JavaScript/Reference under the official name of the IDL/spec, with a summary in the glossary pointing to that documentation and example implementations within MDN and in the wild.

Thanks. I don't disagree. Though note, this is the same approach as transferrable objects and serializable objects in the glossary.

I quite like the idea of having these as sections in Map and Set. @wbamberg any comments?

Josh-Cena · 2023-06-07T12:16:14Z

this is the same approach as transferrable objects and serializable objects in the glossary.

https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Transferable_objects is now a Web API page as well.

estelle · 2023-06-07T15:25:20Z

Thanks. I don't disagree. Though note, this is the same approach as transferrable objects and serializable objects in the glossary.

There are a few glossary items, including these, that need to be revisited and de-glossary-ified (Base 64 is another one). Now that transferable objects has an API page, it will be easier to do. Let's not add to that. I also quite like the idea of having these as sections in Map and Set as @Josh-Cena suggested

hamishwillee · 2023-06-07T22:50:53Z

I do too. I'll looking to moving this stuff either Friday or next week, firefox-project work permitting.

files/en-us/glossary/maplike_object/index.md

files/en-us/glossary/setlike_object/index.md

wbamberg · 2023-06-09T01:43:30Z

We talked about this in the SC meeting on Wednesday. I had forgotten about transferable and serializable, and agree that they're the same kind of thing. I agree that glossary is not a great place to put pages like this, and am happy FWIW for them to go in the JS docs, for now.

But I think we need a proper home for pages like this, that cover general categories in Web/API. In the SC meeting we talked about having a project in H2 to figure out a proper home for them.

hamishwillee · 2023-06-09T03:07:54Z

@wbamberg Thanks for the information. That all makes sense to me, though for this particular case adding this to Map/Set feels like a good fit. The only problem is that it is cleaner not to mix JavaScript and WebAPI.

@Josh-Cena I have moved this to the Map and Set topics so good time for a new review.

files/en-us/web/javascript/reference/global_objects/map/index.md

files/en-us/web/javascript/reference/global_objects/set/index.md

files/en-us/web/javascript/reference/global_objects/map/index.md

hamishwillee · 2023-06-13T02:16:15Z

@Josh-Cena @wbamberg Would appreciate a review on this when you have time. I have updated the titles to "X-like browser APIs" in the respective docs to reflect upcoming JavaScript Set-like objects.

files/en-us/web/api/xranchorset/index.md

files/en-us/web/api/highlightregistry/index.md

files/en-us/web/api/highlight/index.md

files/en-us/web/api/gpusupportedfeatures/index.md

files/en-us/web/javascript/reference/global_objects/set/index.md

files/en-us/web/javascript/reference/global_objects/map/index.md

files/en-us/web/javascript/reference/global_objects/set/index.md

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

Josh-Cena

Little nits. @wbamberg said about making a dedicated page for web IDL entities (IIUC); I don't have strong opinions but that does sound more scalable.

files/en-us/web/javascript/reference/global_objects/map/index.md

files/en-us/web/javascript/reference/global_objects/set/index.md

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

Josh-Cena

Let's pick one. I don't have preferences

files/en-us/web/javascript/reference/global_objects/map/index.md

files/en-us/web/javascript/reference/global_objects/set/index.md

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

hamishwillee · 2023-06-15T22:54:34Z

Thanks. Works for me.

hamishwillee · 2023-06-15T22:54:52Z

Can we merge this?

Josh-Cena · 2023-06-16T03:39:44Z

Oops, @hamishwillee—you were supposed to pick one suggestion (indent by 2 or 4)...

files/en-us/web/javascript/reference/global_objects/map/index.md

hamishwillee · 2023-06-16T03:53:54Z

@Josh-Cena I guess I should learn to read - saw that as fixes to two cases. I have decided on "2 spaces". Fixed

Josh-Cena

I am approving and will merge in the next few days unless @wbamberg gives a -1 on the current approach.

files/en-us/web/api/rtcstatsreport/index.md

files/en-us/web/javascript/reference/global_objects/map/index.md

wbamberg

@Elchi3 filed openwebdocs/project#159 which might revisit things, but this is fine. Thank you @hamishwillee !

hamishwillee requested review from a team as code owners June 6, 2023 05:21

hamishwillee requested review from wbamberg and removed request for a team June 6, 2023 05:21

github-actions bot added Content:Glossary Glossary entries Content:WebAPI Web API docs labels Jun 6, 2023

hamishwillee mentioned this pull request Jun 6, 2023

RTCStatsReport - make this the center of statistics docs #27028

Merged

Josh-Cena reviewed Jun 6, 2023

View reviewed changes

files/en-us/glossary/maplike_object/index.md Outdated Show resolved Hide resolved

files/en-us/glossary/setlike_object/index.md Outdated Show resolved Hide resolved

files/en-us/glossary/setlike_object/index.md Outdated Show resolved Hide resolved

estelle reviewed Jun 6, 2023

View reviewed changes

bsmth reviewed Jun 8, 2023

View reviewed changes

files/en-us/glossary/maplike_object/index.md Outdated Show resolved Hide resolved

bsmth reviewed Jun 8, 2023

View reviewed changes

files/en-us/glossary/maplike_object/index.md Outdated Show resolved Hide resolved

bsmth reviewed Jun 8, 2023

View reviewed changes

files/en-us/glossary/setlike_object/index.md Outdated Show resolved Hide resolved

hamishwillee added 5 commits June 9, 2023 13:03

Glossary: Maplike - and associated changes

139ab8a

Glossary: Setlike

001005d

Run prettier

6e76ab4

Move maplike content to Map topic

c458af2

Move setlike to Set

f35c9a4

hamishwillee force-pushed the maplike_setlike branch from 390bf96 to f35c9a4 Compare June 9, 2023 03:03

hamishwillee requested a review from a team as a code owner June 9, 2023 03:03

github-actions bot added Content:JS JavaScript docs and removed Content:Glossary Glossary entries labels Jun 9, 2023

hamishwillee changed the title ~~Glossary - new entries for Maplike and Setlike objects~~ Maplike and Setlike objects in Map and Set Jun 9, 2023

hamishwillee commented Jun 9, 2023

View reviewed changes

files/en-us/web/javascript/reference/global_objects/map/index.md Show resolved Hide resolved

Josh-Cena reviewed Jun 12, 2023

View reviewed changes

files/en-us/web/javascript/reference/global_objects/set/index.md Outdated Show resolved Hide resolved

hamishwillee commented Jun 13, 2023

View reviewed changes

files/en-us/web/javascript/reference/global_objects/set/index.md Outdated Show resolved Hide resolved

hamishwillee commented Jun 13, 2023

View reviewed changes

files/en-us/web/javascript/reference/global_objects/map/index.md Outdated Show resolved Hide resolved

Apply suggestions from code review

931f1d8

Josh-Cena reviewed Jun 13, 2023

View reviewed changes

hamishwillee and others added 4 commits June 13, 2023 14:39

Apply suggestions from code review

dd0a0a8

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

Apply suggestions from code review

9a72ae2

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

Update files/en-us/web/javascript/reference/global_objects/map/index.md

d711517

Update files/en-us/web/javascript/reference/global_objects/set/index.md

1dd7928

Josh-Cena reviewed Jun 13, 2023

View reviewed changes

Apply suggestions from code review

55a218f

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

Josh-Cena reviewed Jun 15, 2023

View reviewed changes

files/en-us/web/javascript/reference/global_objects/map/index.md Show resolved Hide resolved

files/en-us/web/javascript/reference/global_objects/set/index.md Outdated Show resolved Hide resolved

Apply suggestions from code review

5cbb3d5

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

hamishwillee commented Jun 16, 2023

View reviewed changes

files/en-us/web/javascript/reference/global_objects/map/index.md Outdated Show resolved Hide resolved

Update files/en-us/web/javascript/reference/global_objects/map/index.md

1e7b29b

Josh-Cena approved these changes Jun 16, 2023

View reviewed changes

files/en-us/web/api/rtcstatsreport/index.md Outdated Show resolved Hide resolved

files/en-us/web/javascript/reference/global_objects/map/index.md Outdated Show resolved Hide resolved

Apply suggestions from code review

15b8c07

wbamberg approved these changes Jun 16, 2023

View reviewed changes

Josh-Cena merged commit 8dcea68 into mdn:main Jun 16, 2023

hamishwillee deleted the maplike_setlike branch June 18, 2023 23:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Maplike and Setlike objects in Map and Set #27160

Maplike and Setlike objects in Map and Set #27160

hamishwillee commented Jun 6, 2023

github-actions bot commented Jun 6, 2023 •

edited

Loading

Josh-Cena left a comment

estelle left a comment

Josh-Cena commented Jun 6, 2023

hamishwillee commented Jun 6, 2023

Josh-Cena commented Jun 7, 2023

estelle commented Jun 7, 2023

hamishwillee commented Jun 7, 2023

wbamberg commented Jun 9, 2023

hamishwillee commented Jun 9, 2023

hamishwillee commented Jun 13, 2023

Josh-Cena left a comment

Josh-Cena left a comment •

edited

Loading

hamishwillee commented Jun 15, 2023

hamishwillee commented Jun 15, 2023

Josh-Cena commented Jun 16, 2023

hamishwillee commented Jun 16, 2023

Josh-Cena left a comment

wbamberg left a comment

Maplike and Setlike objects in Map and Set #27160

Maplike and Setlike objects in Map and Set #27160

Conversation

hamishwillee commented Jun 6, 2023

github-actions bot commented Jun 6, 2023 • edited Loading

Josh-Cena left a comment

Choose a reason for hiding this comment

estelle left a comment

Choose a reason for hiding this comment

Josh-Cena commented Jun 6, 2023

hamishwillee commented Jun 6, 2023

Josh-Cena commented Jun 7, 2023

estelle commented Jun 7, 2023

hamishwillee commented Jun 7, 2023

wbamberg commented Jun 9, 2023

hamishwillee commented Jun 9, 2023

hamishwillee commented Jun 13, 2023

Josh-Cena left a comment

Choose a reason for hiding this comment

Josh-Cena left a comment • edited Loading

Choose a reason for hiding this comment

hamishwillee commented Jun 15, 2023

hamishwillee commented Jun 15, 2023

Josh-Cena commented Jun 16, 2023

hamishwillee commented Jun 16, 2023

Josh-Cena left a comment

Choose a reason for hiding this comment

wbamberg left a comment

Choose a reason for hiding this comment

github-actions bot commented Jun 6, 2023 •

edited

Loading

Josh-Cena left a comment •

edited

Loading