Should API ref template ref method/property structure be same as Javascript #245
-
The API ref page template does not separate static and instance properties and methods - so it looks like this:
The Javascript docs have this structure (no documented template):
Should the API ref template match Javascript in this respect? It seems to me that the distinction is useful, so we should match them. This comes out of mdn/content#21241 |
Beta Was this translation helpful? Give feedback.
Replies: 3 comments 5 replies
-
For what it’s worth, I sort of followed the Javascript pattern in documenting the Temporal API (e.g. https://github.com/meyerweb/content/blob/temporal/files/en-us/web/javascript/reference/global_objects/temporal/calendar/index.md), and it made sense to me. So I’m in favor. |
Beta Was this translation helpful? Give feedback.
-
I think the Web/API interface pages should split static and instance methods/properties, yes. We can use page types to know which are which :) and also https://docs.google.com/spreadsheets/d/14RX8EEKPpeYkP2cF5Y_ZKF3JpNJ_24OL7stvZWNJLIY/edit#gid=2070323159. |
Beta Was this translation helpful? Give feedback.
-
The answer is that this is agreed - Web API interface pages will split up the types to static/instance for properties and methods. Page template updated (might not render yet): https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Page_structures/Page_types/API_reference_page_template I'll kick off a mini project to fix up the whole web API as it is now - later in the week. |
Beta Was this translation helpful? Give feedback.
The answer is that this is agreed - Web API interface pages will split up the types to static/instance for properties and methods. Page template updated (might not render yet): https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Page_structures/Page_types/API_reference_page_template
I'll kick off a mini project to fix up the whole web API as it is now - later in the week.