[Zope] doc string rules

[Dennis Allison]

Thanks.  What about classes & modules?  Should Foo, in you example, have a=
=20
doc string?  What about the module that Foo belongs to?

On Fri, 2 Jul 2004, Bogdan M. Maryniuck wrote:

> On Thu, Jul 01, 2004 at 08:34:13PM -0700, Dennis Allison wrote:
> > I just had LocalFS break under Zope 2.6.4 with Python 2.3.4 due to a=20
> > "missing docstring".  What are the current rules?  Must everything=20
> > (procedures, methods, classes, modules) have docstrings?  Even when=20
> > running with Z_DEBUG_MODE set to "yes".
>=20
> All methods you want to gets published should have at least empty docstri=
ng and=20
> do not have a name beginning with underscore:=20
>=20
> class Foo:
>     def pulishme(self):
>         """ """
>=20
>=20
>     def donotpublishme(self):
>         pass
>=20
>=20
>     def _donotpublishmealso(self):
>         """ """
>=20
> --=20
> =E6=9A=AE
>=20
> This host is a black hole at HTTP wavelengths. GETs go in, and nothing
> comes out, not even Hawking radiation.
> =09=09-- Graaagh the Mighty on rec.games.roguelike.angband
>=20