Overview
- Title
- read and improve api docs
- Duration
- 120
- Difficulty
- Medium
- Types
- Documentation,Code
- Tags
- rst,sphinx,python
- Mentors
- thomaswaldmann,rb_proj,waldi,esyr,pkumar_7
- Count
- -3
Description
Abstract
For moin2 we use sphinx (and rst markup) for documentation.
The documentation contains hand written docs for users, admins and developers as well as a automatically generated API reference section.
Your task is to read through a part of the (html rendered) API docs and improve the (python) source code it was generated from.
Note: This task is a good preparation for a coding task.
Details
TODO:
choose some module not already done, see bottom of this wiki page
- improve how rendered API docs look (e.g. fix rst markup errors, add rst markup)
- add missing docstrings in the code
- improve usability of the API docs (e.g. add cross references, highlight important stuff)
- try to stay in same package, same module preferably
- if you touch some module, you have to complete it, don't do partial stuff
- always render the api docs with sphinx after doing changes and check whether it is ok then
- run py.test MoinMoin/_tests/test_sourcecode.py and fix failing tests
update this wiki page with the modules you completed
You are finished with this task when the unified diff is >= 100000 (100kB) - but please always complete the current module/file:
diff -ur originaltree modifiedtree | wc --bytes
hg diff | wc --bytes
please note that a unified diff is much larger than the changes you did, because it also includes context lines and the FULL new AND old line.
Deliverables: patch or changeset
Skill Requirements
rst,sphinx,python
You do not need to write python code, but you should understand and know how to write python code to be able to do this task with good results.
Links
Discussion
Modules already done
...