Project

General

Profile

Bug #126

Bug #128: Initial versioned release

Bug #127: Documentation for initial release (and beyond)

Docstrings for core functionality.

Added by Joseph Spiros almost 13 years ago. Updated almost 13 years ago.

Status:
Resolved
Priority:
High
Assignee:
Joseph Spiros
Category:
Core
Target version:
-
Start date:
04/26/2011
Due date:
% Done:

90%

Estimated time:

Description

As part of our effort to document Philo properly, I'd like us to write Sphinx-formatted docstrings for all public APIs in core (meaning, everything except the contrib apps). As a guide, see how I've documented source:contrib/gilbert/extdirect/core.py@f314a8ddceb543e2bb4711d50bdd2060452689b1.

History

#1

Updated by Joseph Spiros almost 13 years ago

  • Parent task set to #127
#2

Updated by Stephen Burrows almost 13 years ago

  • Status changed from New to In Progress
  • % Done changed from 0 to 80

Core docs are done for everything except the admin interface. To a certain extent, the admin is not really "public" - should we document it anyway?

#3

Updated by Stephen Burrows almost 13 years ago

Also, so that I don't forget: there's a slight issue with documenting philo.models.File.file and philo.models.nodes.TargetURLModel.reversing_parameters - both raise AttributeErrors when an attempt is made to access them, which means the docstrings are inaccessible.

#4

Updated by Stephen Burrows almost 13 years ago

  • Assignee set to Joseph Spiros
  • % Done changed from 80 to 90

Finished docstrings last friday - just need stilistic comb-through.

#5

Updated by Joseph Spiros almost 13 years ago

  • Status changed from In Progress to Resolved

Marking as resolved for now. Obviously we'll need to maintain these as we go into the future.

Also available in: Atom PDF