openedx / openedx/openedx-filters
Improve code annotations and integrate with docs
A pull request for this has already been merged.
- #173 by @mariajgrimaldi — merged
- Dominant language
- Python
- Stars
- 10
- Forks
- 28
- Avg merge
- 3d 8h
- Merged PRs (30d)
- 8
Description
We should have a way of automatically generating documentation for each filter, just as it happens with openedx-events: https://github.com/openedx/openedx-events/issues/316
Also, in-line docs for each class should be improved. Another thing we should do is to make available the different versions on the docs page
### Tasks
- [ ] https://github.com/openedx/openedx-filters/pull/173
- [ ] Improve in-line documentation for each filter class
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
Review the related openedx-events issue 316 and the merged pull request 173 first, then inspect how openedx-filters currently documents its filter classes and publishes documentation versions. Done should include automatically generated documentation for each filter, improved inline class documentation, and available documentation versions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100