Add api Docstrings from some source (e.g., MDN)
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 23
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
Primary goal: provide minimal docstrings on the Apis.
Secondary goals:
- open up and pave the road to adding compatibility informations aka supported platforms (see issue
- add a link to mdn docs when available
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the MDN content markup for Web APIs with the TypeScript-DOM-lib-generator comments.json and its generated documentation. Determine how minimal docstrings, future supported-platform information, and MDN links should be represented in webtypy. Done means the approach is defined and API docstrings are added consistently, with the relevant source links preserved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, typescript
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100