seibert / ln

Natural Log is a time-series database with a REST API.
BSD 2-Clause "Simplified" License
2 stars 0 forks source link

Backend subclasses should inherit docstrings from base class #1

Open seibert opened 11 years ago

seibert commented 11 years ago

The Backend base class has perfectly nice docstrings, but none of these will show up if you type:

help(ln.backend.sql.SQLBackend)

Sphinx apparently will pick up on the docstrings from parent classes, but other documentation display tools do not.

There is a recipe for docstring inheritance via a decorator here: http://code.activestate.com/recipes/576862/