+1 for more comments in the code. Also, sometimes comments/docstrings need
to be updated when changes are made.
On Tuesday, September 20, 2011 3:55:24 AM UTC-4, David Marko wrote:
>
> Many features have been added recently(last 3 months) but documentation is
> behind these. Can docs can be updated, without this many features will be
> lost somewhere in code. Also as Python is not staticly typed language and
> doesnt use variable type declaration its very often dificult to understand
> it without comments in code or docs.
>
> e.g.
> Here is an example of method signature for SQLFORM.grid. It toook me some
> time to find out the format for fields parameter. I tried
> ['id','name','age'], then ['db.person.id','db.person.name',
> 'db-person.age'], then (db.person.id, db.person.name ...) and the latest
> worked :-) but its just guesswork. And there are many other parameters in
> this method.
>
> def grid(query,
> fields=None,
> field_id=None,
> left=None,
> headers={},
> columns=None,
> orderby=None,
> searchable=True,
> sortable=True,
> paginate=20,
> deletable=True,
> editable=True,
> details=True,
> selectable=None,
> create=True,
> csv=True,
> links=None,
> upload = '<default>',
> args=[],
> user_signature = True,
> maxtextlengths={},
> maxtextlength=20,
> onvalidation=None,
> oncreate=None,
> onupdate=None,
> ondelete=None,
> sorter_icons=('[^]','[v]'),
> ui = 'jquery-ui',
> _class="web2py_grid",
> formname='web2py_grid',
> ):
>
