Please use docstring to document behavior of procedures/methods and
classes.
I.e.
def func(attr):
""" some desc """
rather then
def func(attr):
# some desc
And definitely do not change docstring to plain comments.
def _processFile(filename, relativeDir=None, source=None, nosig=None):
- """ Processes a file
- Returns a hash containing:
- header
- packageSize
- md5sum
- relativePath
- nvrea
- """
+ # Processes a file
+ # Returns a hash containing:
+ # header
+ # packageSize
+ # md5sum
+ # relativePath
+ # nvrea
--
Miroslav Suchy
Red Hat Satellite Engineering
_______________________________________________
Spacewalk-devel mailing list
Spacewalk-devel@redhat.com
https://www.redhat.com/mailman/listinfo/spacewalk-devel
