content icon indicating copy to clipboard operation
content copied to clipboard

Add prose and meta-docs for [LegacyNullToEmptyString]

Open teoli2003 opened this issue 2 years ago • 6 comments
trafficstars

Description

This PR adds relevant information to existing MDN pages about properties or method parameters prefixed with the WebIDL [LegacyNullToEmptyString].

Motivation

This is part of openwebdocs/project#159 where we want to uniformize and add more information stored in WebIDLs files. Standardizing them makes them easier to understand and MDN Web docs articles more precise.

Additional details

What does this extended attribute mean?

This extended attribute alters how null values are converted to a string. The standard way is to convert null to the string "null". When this extended attribute is present, the null object is converted to an empty string ("").

What does this PR do?

  • It adds to all relevant properties a sentence explaining the set behaviour when set to the null value, with a tiny inline example.
  • It adds to all such parameters a sentence explaining what the behaviour is when null is passed.
  • Update the meta-docs, listing the standardized sentences.

Related issues and pull requests

None.

teoli2003 avatar Jul 27 '23 10:07 teoli2003

Preview URLs (21 pages)
Flaws (1)

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

URL: /en-US/docs/MDN/Writing_guidelines/Page_structures/Page_types/API_property_subpage_template Title: API property subpage template Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/MDN/Writing_guidelines/Howto/Write_an_API_reference/Information_contained_in_a_WebIDL_file#type_of_the_property

(comment last updated: 2024-07-12 01:42:10)

github-actions[bot] avatar Jul 27 '23 10:07 github-actions[bot]

All looks good to me! Agree with @wbamberg suggestions and one nit :)

Rumyra avatar Aug 02 '23 08:08 Rumyra

@teoli2003 , are you coming back to this, or should we close it for now?

wbamberg avatar Oct 25 '23 05:10 wbamberg

Hi @teoli2003 shall we close this for now?

bsmth avatar Jan 10 '24 10:01 bsmth

Hi @teoli2003 shall we close this for now?

I have fixed all open points and rebased. Let's ask for a re-review.

teoli2003 avatar Jan 10 '24 12:01 teoli2003

This pull request has merge conflicts that must be resolved before it can be merged.

github-actions[bot] avatar May 02 '24 05:05 github-actions[bot]

I'm open to merging this if no other feedback is given before end of week.

Josh-Cena avatar Jul 10 '24 22:07 Josh-Cena

Going to merge now. Thanks everyone!

Josh-Cena avatar Jul 12 '24 15:07 Josh-Cena