Docs: Library functions need documentation

Bug #486958 reported by Matt Giuca
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Mars
Fix Released
Medium
Matt Giuca

Bug Description

None of the library functions are documented (they have empty pages in the documentation).

This is because Sphinx doesn't give us an easy way to write Mars function headers. Add a Sphinx plugin for rendering Mars functions (basically Python functions with type signatures).

Tags: docs

Related branches

Revision history for this message
Matt Giuca (mgiuca) wrote :

Sphinx extension (mars.desc) is now written and active in trunk. You can now use ".. marsfunc" and the like, to write full Mars function headers in the Sphinx documentation.

Changed in mars:
status: Triaged → In Progress
Revision history for this message
Matt Giuca (mgiuca) wrote :

Fixed in trunk r1061.

Changed in mars:
status: In Progress → Fix Committed
Matt Giuca (mgiuca)
Changed in mars:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.