#663: Migrating away from epydoc to...
-------------------------+-------------------------------------------------
Reporter: skaplun | Owner:
Type: | Status: new
enhancement | Milestone:
Priority: minor | Version:
Component: *general* | Keywords: epydoc sphynx docstring
Resolution: | documentation
-------------------------+-------------------------------------------------
Comment (by simko):
Replying to [comment:1 jblayloc]:
> switching is a great idea if for no other reason than because it forces
us to revisit outdated docs (eventually).
Using in-the-code documentation facilitates keeping both the code and its
documentation in sync and up to date. People have been frequently
updating both, so we are not that off the track in this area, actually.
However, we have not even finished migrating to epydoc markup yet. Many
older modules still use whatever docstring convention was used by the
given modules originally. Even for modules using epydoc, there are quite
a few troubles when running kwalitee `--check-docstrings`.
Just a reminder of this hackathon task that is of evergreen nature
irrespective of the docstring markup format.
--
Ticket URL: <http://invenio-software.org/ticket/663#comment:3>
Invenio <http://invenio-software.org>
