-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Guenter Milde schrieb: > On 2009-11-09, Joshua Bronson wrote: > >> I'd like to be able to associate a docstring with an instance >> attribute in such a way that autodoc will discover it along with the >> rest of the documentation for the class's properties, methods, and >> class attributes. > > The following is the convention used in the Docutils sources. I don't know > whether it currently works, but it might be worth considering:: > > class Foo: > parrot = "dead" > """class attribute docstring""" > > def __init__(self): > self.bar = 1 > """instance attribute docstring"""
For class attributes it already does, for instance attributes it will work together with the comment-based approach as soon as I implement issue #280. Georg -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.13 (GNU/Linux) iEYEARECAAYFAkr6ficACgkQN9GcIYhpnLDcLACfc8d4lvp80Y+2aTuTtalRaZIB dpsAnRQIDIg+tbKXfvRRDw/UkQyTopWy =VXMl -----END PGP SIGNATURE----- --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~----------~----~----~----~------~----~------~--~---
