pyodide / webtypy

Python type definitions for web APIs
Mozilla Public License 2.0
13 stars 3 forks source link

Add api Docstrings from some source (e.g., MDN) #5

Open simonegiacomelli opened 1 year ago

simonegiacomelli commented 1 year ago

Primary goal: provide minimal docstrings on the Apis. Secondary goals:


The MDN content markup may be a good source of structured data to harvest (and its html counterpart).

Also notice some comments in a json file from TypeScript-DOM-lib-generator; probably used to fuel Typescript stubs comments (don't know how this json is made).

Another source to investigate probably generated from Typescript stubs.

simonegiacomelli commented 1 year ago

Interesting article about the MDN transition from html to markdown

simonegiacomelli commented 1 year ago

Yari is the code that renders MDN Web Docs. This folder contains the KumaScript macros used as part of the rendering; they are interesting because they are used to process inter-page links.

simonegiacomelli commented 1 year ago

It looks to me that the best course of action is to use yari and the MDN markdown.

One interesting read is about compatibility tables and BCD (Browser Compatibility Data).