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

feat: improvements on attribute & boolean/html #34728

Merged
merged 17 commits into from
Jul 10, 2024

Conversation

PassionPenguin
Copy link
Contributor

@PassionPenguin PassionPenguin commented Jul 9, 2024

@chrisdavidmills a further update than #33386 - boolean attribute actually have an individual entry /Glossary/Boolean/HTML

  • fixed: trimed down /Glossary/Attribute, moving the detailed information of boolean attribute onto /Glossary/Boolean/HTML
  • fixed: out-dated information according to the HTML spec 2.3.2 under /Glossary/Boolean/HTML
Screenshot 2024-07-09 at 4 00 07 PM
  • added: inter-glossary links

@PassionPenguin PassionPenguin requested a review from a team as a code owner July 9, 2024 08:02
@PassionPenguin PassionPenguin requested review from hamishwillee and removed request for a team July 9, 2024 08:02
@github-actions github-actions bot added Content:Glossary Glossary entries size/m [PR only] 51-500 LoC changed labels Jul 9, 2024
Copy link
Contributor

github-actions bot commented Jul 9, 2024

Preview URLs

Flaws (2)

Note! 1 document with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Glossary/Attribute
Title: Attribute
Flaw count: 2

  • macros:
    • /en-US/docs/Web/API/HTMLInputElement/placeholder does not exist
    • /en-US/docs/Web/API/HTMLInputElement/placeholder does not exist
External URLs (1)

URL: /en-US/docs/Glossary/Boolean/HTML
Title: Boolean attribute (HTML)

(comment last updated: 2024-07-10 11:10:49)

@Josh-Cena
Copy link
Member

Josh-Cena commented Jul 9, 2024

The paragraph in the spec below your screenshot says what you removed in the content:

If the attribute is present, its value must either be the empty string or a value that is an ASCII case-insensitive match for the attribute's canonical name, with no leading or trailing whitespace.

This glossary entry was written less than 2 years ago, so it's definitely not outdated.

files/en-us/glossary/attribute/index.md Outdated Show resolved Hide resolved
files/en-us/glossary/boolean/html/index.md Outdated Show resolved Hide resolved
@PassionPenguin
Copy link
Contributor Author

The paragraph in the spec below your screenshot says what you removed in the content:

If the attribute is present, its value must either be the empty string or a value that is an ASCII case-insensitive match for the attribute's canonical name, with no leading or trailing whitespace.

This glossary entry was written less than 2 years ago, so it's definitely not outdated.

Oops, that's correct. shall i do a cleanup right after.

@Josh-Cena
Copy link
Member

Josh-Cena commented Jul 10, 2024

The same comment as your other glossary updates: the content, in its current form, is correct and understandable. We would prefer to make as few changes to it as possible unless there are provable errors.

The changes I would personally like to see in this PR:

  1. Remove the misleading implication that "attribute without equals sign" and "boolean attribute" have anything to do with each other. "Attribute without equals sign" is not necessarily boolean and boolean attribute is not necessarily specified without equals sign. I'm fine with a passing mention on the "attributes" page that "HTML attributes have types; for example there are boolean attributes, enumerated attributes, etc." but it doesn't tell you anything about the syntax.
  2. The <input required> example is good and should indeed be moved to the "boolean" entry.
  3. More related glossary terms links are good.

Apart from these, I would take all other changes as unnecessary, but I remain convincible. What I (and other content reviewers, as you have experienced) would prefer not to see is pure cosmetic text changes. It's best if all your changes are additive without changing existing content unless necessary.

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

- no value at all, e.g. `attribute`
- the empty string, e.g. `attribute=""`
- attribute's name itself, with no leading or trailing whitespace, e.g. `attribute="attribute"`
- attribute's canonical name, with no leading or trailing whitespace, e.g. `attribute="attribute"`
Copy link
Member

Choose a reason for hiding this comment

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

Personal suggestion is we don't have to go so technical. "Canonical name" is just because HTML is case-insensitive, but we have never mentioned anything other than lowercase, and I would expect most readers to believe they can only be written lower-cased. I'm fine either way.

files/en-us/glossary/boolean/html/index.md Show resolved Hide resolved
@github-actions github-actions bot added size/s [PR only] 6-50 LoC changed and removed size/m [PR only] 51-500 LoC changed labels Jul 10, 2024
Copy link
Member

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

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

I have gone ahead and made some changes myself, which IMO are necessary before merging this PR. @PassionPenguin thank you for the work—this looks great! I have annoyed you enough so let's merge this now 😄

@PassionPenguin
Copy link
Contributor Author

I have gone ahead and made some changes myself, which IMO are necessary before merging this PR. @PassionPenguin thank you for the work—this looks great! I have annoyed you enough so let's merge this now 😄

Thanks. Your and other reviewer's points on the reviewing process are reasonable and thanks for your kind review.

You are right, that I have made some many unnecessary changes to the content. Though some of them might have improved the content, many are unnecessary, and even breaks the content.

In this case, what I do not take enough care is having moved content from /Glossary/Attribute to /Glossary/Boolean/HTML without a second thought. Sincerely thanks and appreciations for the suggestions made.

p.s. in the last commit, I have added a macro link (in the main content). everything else looks great. Thanks for your work!

@Josh-Cena Josh-Cena merged commit 26635ef into mdn:main Jul 10, 2024
8 checks passed
@PassionPenguin PassionPenguin deleted the bool-attr branch July 11, 2024 07:10
evelinabe pushed a commit to evelinabe/mdn-content that referenced this pull request Jul 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Glossary Glossary entries size/s [PR only] 6-50 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants