taskotron / libtaskotron

#96 convert docstrings to sphinx format
Closed: Fixed Opened by tflink.

Closed: Fixed
Reopen Issue

Right now, the docstring format in libtaskotron is very inconsistent. Since we're using sphinx for documentation, it would be best to have all the docstrings in [[http://sphinx-doc.org/domains.html#info-field-lists|the format specified by Sphinx]].

Go through the entirety of libtaskotron and convert existing docstrings to Sphinx

This ticket had assigned some Differential requests:
D98
D119

Since we want to provide some meaningful documentation for our first release, I'll take this and try to convert a few important modules.

All libtaskotron core modules were converted, but we still need to adjust the directives. Not sure if this needs to be done in time for release.

we still need to adjust the directives. Not sure if this needs to be done in time for release.

The final documentation still needs to be done but for the current release, the output from #168 and #159 are good enough until we get the whole license/tool thing figured out.

Metadata Update from @tflink:
- Issue tagged with: easyfix
Metadata
None

easyfix

None
None
Low
Static archive. pagure.io was sunset in 2026; this is a read-only snapshot.
Red Hat Logo

Fedora is sponsored by Red Hat. Learn more about the relationship between Red Hat and Fedora »

© Red Hat, Inc. and others.