[Networkit] Documenting Python Modules

Christian Staudt christian.staudt at kit.edu
Sat Sep 20 13:34:01 CEST 2014


Hi NetworKit developers,

please help making sure that Python modules are properly documented. In particular, the first thing in a .py file should be the docstring, 
a triple-quoted string describing the purpose of the module. Then, authorship information should follow, e.g.

"""
This module provides methods to export data from NetworKit directly to Gephi using the
Gephi Streaming Plugin.
"""

__author__ = "Gerd Lindner, Moritz v.Looz“

Best regards,
Christian

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 495 bytes
Desc: Message signed with OpenPGP using GPGMail
URL: <https://lists.ira.uni-karlsruhe.de/mailman/private/networkit/attachments/20140920/ffb255e3/attachment.sig>


More information about the NetworKit mailing list