After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 682679 - Add docstrings to major functions/methods
Add docstrings to major functions/methods
Status: RESOLVED OBSOLETE
Product: damned-lies
Classification: Infrastructure
Component: general
unspecified
Other Linux
: Normal enhancement
: ---
Assigned To: damned-lies Maintainer(s)
damned-lies Maintainer(s)
Depends on:
Blocks:
 
 
Reported: 2012-08-25 18:33 UTC by Gil Forcada
Modified: 2018-05-22 12:13 UTC
See Also:
GNOME target: ---
GNOME version: ---


Description Gil Forcada 2012-08-25 18:33:11 UTC 
As Damned-Lies does quite a lot of things already, it would be nice if we could get some docstrings[1] for big methods (no need to add a docstring for a 3 lines method :)

Task: review python code files scanning for big methods/classes and add some docstrings on them commenting what they do, input parameters and so on.


[1] http://www.python.org/dev/peps/pep-0257/
Comment 1 GNOME Infrastructure Team 2018-05-22 12:13:57 UTC 
-- GitLab Migration Automatic Message --

This bug has been migrated to GNOME's GitLab instance and has been closed from further activity.

You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.gnome.org/GNOME/damned-lies/issues/36.