Use python docstrings

Bug #1169313 reported by Marco Giusti
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Marco Giusti

Bug Description

Python docstrings are special strings meant to be documentation for the
code. They are accessible by code (via `__doc__` attribute) or `pydoc`,
the python documentation tool.

While they are already many documentation strings, could be useful to
transform them in docstrins but not doing this will not have any
consequences. Quoting pep-257: If you violate these conventions, the
worst you'll get is some dirty looks.

 affects virtualbrick
 tag code-cleanup

Tags: code-cleanup
Changed in virtualbrick:
status: New → Confirmed
importance: Undecided → Wishlist
Changed in virtualbrick:
status: Confirmed → In Progress
assignee: nobody → mg (marco-giusti)
Revision history for this message
Marco Giusti (marco-giusti) wrote :

Invalid: too generic.

Changed in virtualbrick:
status: In Progress → Invalid
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers