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

Correction for the formal syntax not found issue - 03 #19473

Closed
wants to merge 3 commits into from
Closed

Correction for the formal syntax not found issue - 03 #19473

wants to merge 3 commits into from

Conversation

ghost
Copy link

@ghost ghost commented Aug 12, 2022

This is for issue #18780
In this PR I edited the tags of these pages:

  • Custom properties
  • align-tracks
  • justify-tracks
  • masonry-auto-flow
  • padding-block
  • padding-inline
  • paint-order
  • scrollbar-gutter
  • text-decoration-thickness
  • text-underline-offset

I simply added CSS property tag.

@ghost ghost self-requested a review as a code owner August 12, 2022 18:02
@ghost ghost requested review from estelle and removed request for a team August 12, 2022 18:02
@github-actions github-actions bot added the Content:CSS Cascading Style Sheets docs label Aug 12, 2022
@teoli2003
Copy link
Contributor

This is for issue #18780

In this PR I covered:

17.https://developer.mozilla.org/en-US/docs/Web/CSS/--_star_ Resource: https://www.w3.org/TR/css-variables-1/

This sounds like it should be coming from w3c/webref…

@ghost
Copy link
Author

ghost commented Aug 12, 2022

@teoli2003 how should I change it?

@teoli2003
Copy link
Contributor

Can you double-check the values from w3cub with the ones in mdn/data? If some are different, it would be interesting to double-check.

@ghost
Copy link
Author

ghost commented Aug 12, 2022

How should I do that?
Sorry for asking because I am not sure.
MDN is not retrieving formal syntax data? and this should not be the same as w3doc?

@teoli2003
Copy link
Contributor

How should I do that? Sorry for asking because I am not sure. MDN is not retrieving formal syntax data? and this should not be the same as w3doc?

I don't where w3cub is taking its syntax. It isn't a w3c official site, it's just somebody maintaining docs (which is fine).

In mdn/data we were maintaining a list of formal syntax, and I would like to be sure we are completely coherent here:
like there for CSS Properties: https://github.com/mdn/data/blob/main/css/properties.json

@teoli2003
Copy link
Contributor

@teoli2003 how should I change it?

You shouldn't do it manually, we should fix the macro (or webref) to get it from w3c/webref.

Only non-standard features should have hard-coded values.

@ghost ghost mentioned this pull request Aug 12, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Aug 14, 2022

Preview URLs

Flaws

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

URL: /en-US/docs/Web/CSS/--*
Title: Custom properties (--*): CSS variables
on GitHub
Flaw count: 2

  • bad_bcd_links:
    • no explanation!
    • no explanation!

External URLs

URL: /en-US/docs/Web/CSS/--*
Title: Custom properties (--*): CSS variables
on GitHub

No new external URLs


URL: /en-US/docs/Web/CSS/align-tracks
Title: align-tracks
on GitHub

No new external URLs

(this comment was updated 2022-08-14 10:28:49.023576)

@wbamberg
Copy link
Collaborator

@najmiehsa , it looks like this updated all the tags, which I already did in #19469 , as noted in #18780 (comment).

If you want to help out with this issue, then I think it would be best to work on the items listed in #18780 (comment): these are nonstandard items for which we want to hardcode the formal syntax.

"hardcode the formal syntax" means: find the formal syntax entry for the item in the mdn/data repository and copy it into the page, inside a Markdown <pre> block.

For example, considering the first in this list, https://developer.mozilla.org/en-US/docs/Web/CSS/-moz-float-edge. You can find the entry for it in mdn/data, in the "properties.json" file: https://github.com/mdn/data/blob/80aedce42a7f3a523a17e54ba87b0680ee171daf/css/properties.json#L936-L951. The formal syntax is in the "syntax" key and is given as "border-box | content-box | margin-box | padding-box".

So copy that value, and in https://github.com/mdn/content/blob/main/files/en-us/web/css/-moz-float-edge/index.md, replace {{csssyntax}} with the value, inside a Markdown <pre> block, like:

```
border-box | content-box | margin-box | padding-box
```

I think it would be good to submit an initial PR fixing just the https://developer.mozilla.org/en-US/docs/Web/CSS/-moz-float-edge, to be sure you have the right idea. Then you can submit another fixing the rest.

Thanks for your help!

@wbamberg wbamberg closed this Aug 18, 2022
@ghost
Copy link
Author

ghost commented Aug 18, 2022

@wbamberg I've already edited the other PR based on this.

@ghost ghost deleted the F3syntax branch August 18, 2022 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:CSS Cascading Style Sheets docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants