-
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
WebAPI: Update Method pages to modern structure (part 9) #15062
Conversation
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.
Awesome work @OnkarRuikar . I had one question about some weirdness in the DataTransfer
API.
@wbamberg As per the syntax section the parameter names do not have any decoration so .main-page-content dl dt {
margin-top: 2rem;
margin-bottom: .5rem;
font-weight: var(--font-body-strong-weight);
} Good catch on I can include removing decorations from parameter names in the PR series. But if we add too many things, the reviews and overall process will become slow. And there are 1458 method pages. 😯 If we focus on one type of correction in a PR series then hundreds of files can be pulled in a PR. I don't know how is the workload on your side. I leave the decision of dealing everything in a single pass or separate things over multiple passes. Honestly, for every API authors have used their own imagination writing syntax sections. I have discussed the bottleneck on my side with Jean here: #15042 (comment) |
Co-authored-by: Jean-Yves Perrier <[email protected]>
Co-authored-by: Jean-Yves Perrier <[email protected]>
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.
Thanks!
This seems to be another discrepancy with the JS docs, where code format for parameter names seems to be the most common approach (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters etc etc).
I'm happy with an answer like "this isn't in scope for this PR". There are so many things to fix, we can't try to do them all at once, and what you have here is already a big improvement. |
Let's handle fixing @wbamberg, @teoli2003 If you have such mass corrections in mind do let me know. For example, updating page tags, as per BCD, with 'deprecated', 'experimental', 'non-standard'. Currently, BCD and page tags are not in sync. I don't know how they are updated. |
What I would much prefer to do here is to deprecate and eventually remove these tags in favour of the BCD values, and have the platform generate banners for these pages from that data: openwebdocs/project#81. |
I'm currently supposed to be working on a project to define "page type" front matter (openwebdocs/project#91) and once we have these types defined there will be work to add them to add the pages they apply to (and also to remove tags that are currently used to do a similar job). |
Continuing #14857
Summary
Updating the method pages to follow the current templates:
https://developer.mozilla.org/en-US/docs/MDN/Structures/Syntax_sections#constructors_and_methods
https://developer.mozilla.org/en-US/docs/MDN/Structures/Page_types/API_method_subpage_template
Changes Include:
{{DOMxRef("DOMString")}}
tostring
Metadata