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

Add prose and meta-docs for [LegacyNullToEmptyString] #28213

Merged
merged 20 commits into from
Jul 12, 2024

Conversation

teoli2003
Copy link
Contributor

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.

@github-actions
Copy link
Contributor

github-actions bot commented Jul 27, 2023

@teoli2003 teoli2003 marked this pull request as ready for review July 27, 2023 10:19
@teoli2003 teoli2003 requested review from a team as code owners July 27, 2023 10:19
@Rumyra
Copy link
Collaborator

Rumyra commented Aug 2, 2023

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

@wbamberg
Copy link
Collaborator

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

@bsmth bsmth added the awaiting response Awaiting for author to address review/feedback label Jan 10, 2024
@bsmth
Copy link
Member

bsmth commented Jan 10, 2024

Hi @teoli2003 shall we close this for now?

files/en-us/web/api/element/innerhtml/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/window/open/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/window/open/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/window/open/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/window/open/index.md Outdated Show resolved Hide resolved
teoli2003 and others added 10 commits January 10, 2024 13:25
…e/information_contained_in_a_webidl_file/index.md

Co-authored-by: Ruth John <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
teoli2003 and others added 6 commits January 10, 2024 13:25
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…e/information_contained_in_a_webidl_file/index.md
@teoli2003
Copy link
Contributor Author

Hi @teoli2003 shall we close this for now?

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

@teoli2003 teoli2003 removed the awaiting response Awaiting for author to address review/feedback label Jan 10, 2024
@github-actions github-actions bot added the merge conflicts 🚧 [PR only] label May 2, 2024
Copy link
Contributor

github-actions bot commented May 2, 2024

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

@github-actions github-actions bot added the size/m [PR only] 51-500 LoC changed label May 2, 2024
@estelle estelle requested a review from Josh-Cena July 10, 2024 06:38
@github-actions github-actions bot removed the merge conflicts 🚧 [PR only] label Jul 10, 2024
@Josh-Cena
Copy link
Member

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

@Josh-Cena
Copy link
Member

Going to merge now. Thanks everyone!

@Josh-Cena Josh-Cena merged commit 4656260 into mdn:main Jul 12, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Meta Content in the meta docs Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants