Wie "property" für API Dokumentation dokumentieren
Verfasst: Samstag 27. Oktober 2007, 21:24
Hoi,
wie macht man in einer API-Doku am besten deutlich, daß eine best. Methode einer Klasse eigentlich eine "property" ist?
Gegenwärtig habe ich z. B. diesen Docstring:
Ist, wenn man das z. B. durch epydoc nudelt, dann allen klar, um was es sich hier handelt? Das man es mit instance.rg erhalten kann? Oder gibt es bessere Konventionen?
Danke,
Christian
wie macht man in einer API-Doku am besten deutlich, daß eine best. Methode einer Klasse eigentlich eine "property" ist?
Gegenwärtig habe ich z. B. diesen Docstring:
Code: Alles auswählen
@property
def rg(self):
"""
property:
radius of gyration
"""
...
Danke,
Christian