Progress Documentation
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 470
- Forks
- 231
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 6
Description
Quote @pmitros: "http://userdocs.readthedocs.org/en/latest/xblocks.html states
"get_progress (method): See documentation in x_module.py:XModuleMixin.get_progress."
It's actually lying, there is no documentation, but if you follow the
cookie trail, and you want to import xmodule's progress.py."
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
Start with the userdocs xblocks page and the documentation reference for x_module.py:XModuleMixin.get_progress. Follow the reference into progress.py to verify what the method exposes and where the missing explanation belongs. Done means the get_progress documentation accurately points readers to the relevant progress implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100