Maplike and Setlike objects in Map and Set

[hamishwillee]

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]

Preview URLs (14 pages)

• /en-US/docs/Web/API/AudioParamMap
• /en-US/docs/Web/API/CustomStateSet
• /en-US/docs/Web/API/EventCounts
• /en-US/docs/Web/API/FontFaceSet
• /en-US/docs/Web/API/GPUSupportedFeatures
• /en-US/docs/Web/API/HighlightRegistry
• /en-US/docs/Web/API/Highlight
• /en-US/docs/Web/API/KeyboardLayoutMap
• /en-US/docs/Web/API/MIDIInputMap
• /en-US/docs/Web/API/MIDIOutputMap
• /en-US/docs/Web/API/RTCStatsReport
• /en-US/docs/Web/API/XRAnchorSet
• /en-US/docs/Web/JavaScript/Reference/Global_Objects/Map
• /en-US/docs/Web/JavaScript/Reference/Global_Objects/Set

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

[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]

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

[hamishwillee]

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]

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]

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]

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

[wbamberg]

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]

@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.

[hamishwillee]

@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.

[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.

[Josh-Cena]

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

[hamishwillee]

Thanks. Works for me.

[hamishwillee]

Can we merge this?

[Josh-Cena]

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

[hamishwillee]

@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.

[wbamberg]

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