Das deutsche Python-Forum

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:

Code: Alles auswählen

    @property
    def rg(self):
        """
            property:
            radius of gyration 
        """
        ...

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

Bei Epydoc ist es klar, weil das properties erkennt und in einem eigenen Abschnitt aufführt.

Also ich habe Epydoc Version 3.0beta1 mit --latex aufgerufen und da kann ich weder eine gesonderte Sektion noch irgendeine andere Makierung erkennen, wenn epydoc ein property trifft.

Gruß,
Christian

Das deutsche Python-Forum

Wie "property" für API Dokumentation dokumentieren

Wie "property" für API Dokumentation dokumentieren