docstring bugs - Githubissues

artemis-analytics / artemis

Apache License 2.0

5 stars 2 forks source link

docstring bugs #20

Closed ryanmwhitephd closed 4 years ago

ryanmwhitephd commented 4 years ago

Existing bugs with current docstrings.

NumPy docstring styles work everywhere else except in the writer.py class to_csv which is implemented as a static method. Not sure why this causes problems.

artemis.io.writer.BufferOutputWriter.to_csv:4: WARNING: Unexpected section title. Parameters ----------

Additional errors in to_csv artemis.io.writer.BufferOutputWriter.to_csv:38: WARNING: Definition list ends without a blank line; unexpected unindent.
several indentation errors in Directed_Graph and febrlgen

ryanmwhitephd commented 4 years ago

Additional bug is that any class with auto doc must have a docstring at the beginning after class MyClass