-
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
Adding "Formal Definition" heading above cssinfo #3363
Conversation
This PR adds a "Formal Definition" heading above cssinfo in the margin web/css doc. I noticed this heading on other property docs and it appeared to be missing here. Let me know if this is buttery or not. Love MDN!!! Thanks!!!
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 think ideally CSS properties should have a top-level heading structure like:
H2 - Constituent properties (if a shorthand)
H2 - Syntax
H2 - Description (optional)
H2 - Formal definition (contains {{cssinfo}})
H2 - Formal syntax (contains {{csssyntax}})
H2 - Examples
H2 - Specifications
H2 - Browser compatibility
H2 - See also
See https://developer.mozilla.org/en-US/docs/Web/CSS/border-color or https://developer.mozilla.org/en-US/docs/Web/CSS/flex#description for an example shorthand property, and https://developer.mozilla.org/en-US/docs/Web/CSS/background-clip for an example not-shorthand property.
So to be really buttery, this should:
-
add an H2#Constituent properties, before the H2#Syntax. This should list the properties for which
margin
is a shorthand. This can use the same wording as in, say, https://developer.mozilla.org/en-US/docs/Web/CSS/border-color#constituent_properties, and means we no longer need the second sentence "It is a shorthand for margin-top, margin-right, margin-bottom, and margin-left.". -
rename H2#Notes to Description, and move it to after H2#Syntax
-
add H2#Formal definition, after the new H2#Description, and put the {{cssinfo}} call after it.
-
move the existing H3#Formal syntax to be an H2 and to follow after the H2#Formal definition. Put the {{csssyntax}} call after it.
Does that make sense?
@wbamberg totally makes sense!!! thank you so much!!! ill get those updates!!! thanks again!!! |
@butterydev were you going to come back to this? |
@butterydev Per #3363 (comment) this PR seems to be waiting on further changes from you. |
I wanted to close this, so pushed some changes along the lines suggested in #3363 (review) . |
Preview URLsFlawsNone! 🎉 External URLsURL: No new external URLs |
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.
lgtm :)
This PR adds a "Formal Definition" heading above cssinfo in the margin web/css doc.
I noticed this heading on other property docs and it appeared to be missing here.
Let me know if this is buttery or not.
Love MDN!!! Thanks!!!
Checklist — To help your pull request get merged faster, please do the following: