-
Notifications
You must be signed in to change notification settings - Fork 22.5k
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
Conversation
Preview URLs Flaws (2)Note! 1 document with no flaws that don't need to be listed. 🎉 URL:
External URLs (1)URL:
(comment last updated: 2024-07-10 11:10:49) |
The paragraph in the spec below your screenshot says what you removed in the content:
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. |
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:
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. |
|
||
- 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"` |
There was a problem hiding this comment.
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.
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
There was a problem hiding this 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 😄
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 p.s. in the last commit, I have added a macro link (in the main content). everything else looks great. Thanks for your work! |
@chrisdavidmills a further update than #33386 - boolean attribute actually have an individual entry
/Glossary/Boolean/HTML
/Glossary/Attribute
, moving the detailed information of boolean attribute onto/Glossary/Boolean/HTML
/Glossary/Boolean/HTML