Better document Javascript Interfaces
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 470
- Forks
- 231
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 6
Description
@pmitros: "https://xblock.readthedocs.org/en/latest/api/fragment.html#xblock.fragment.Fragment.head_html
Should give a prototype of the JavaScript-side function in the doc."
Contributor guide
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
Open the linked Fragment.head_html API documentation at xblock.readthedocs.org/en/latest/api/fragment.html#xblock.fragment.Fragment.head_html and review its current description. Add a prototype for the JavaScript-side function, then verify that the rendered documentation clearly presents the interface.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100