Wie soll ich Klassen- und Objektattribute mit Numpys Stil dokumentieren?

Question

Ich habe gelesen Numpy's documentation standards, und es scheint keine Objektattribute zu erwähnen - nur Klassenattribute.

Also zum Beispiel, wie würde ich Folgendes dokumentieren?

class ClassA(object): 
    """Short description of ClassA 

    Long description of ClassA 

    Parameters 
    ---------- 
    param : param_type, optional 
     param_description 

    Attributes (class) 
    ---------- 
    class_attr : class_attr_type 
     class_attr_description 

    Attributes (object) 
    ---------- 
    obj_attr : obj_attr_type 
     obj_attr_description 

    """ 

    class_attr = 'something' 

    def __init__(self, arg='something else'): 
     self.obj_attr = arg 

EDIT: Ich wollte nur anmerken, dass ich zu Napoleon bin Umschalten, das sagt, dass es Attribute unterstützt, aber nicht speziell Klasse oder Instanz-Attribute.

Answer 1

Ich habe versucht, was in der How to Document Datei in numpy angegeben erwähnt wird. Es erwähnt die Dokumentation von Klassenattributen sollte wie folgt behandelt werden.

Ein Abschnitt Attribute unter dem Abschnitt Parameter befindet, verwendet werden Klassenvariablen zu beschreiben:

Attributes 
---------- 
x : float 
    The X coordinate. 
y : float 
    The Y coordinate. 

Es auf diese Instanz Eigenschaften zu erwähnen, geht sollten ihre eigene Dokumentation haben und nur aufgeführt werden namentlich.

Das ist sinnvoll, aber ich kann keine Beispiele dafür im numpy Quellcode finden. Der nächste, den ich fand, machte etwas anderes in ABCPolyBase class.

Attributes 
---------- 
coef : (N,) ndarray 
... 
Class Attributes 
---------------- 
maxpower : int 

Meiner Meinung nach ist die Dokumentation in der _polybase.py Klasse verwendet wird, ist gut lesbar, aber ich glaube nicht, dass die Class Attributes Nutzung mit Sphinx Autodoc Zusammenfassungen arbeiten.

Ich hoffe, dass diese Information hilfreich ist.