[Doc-SIG] docstring grammar
Tue, 30 Nov 1999 19:38:25 +1100
> I personally would prefer to keep  for references and
> introduce @..@ (or
> some other delimiter) for inline code, mostly because  is
> so common in
> journals as a way of indicating bibliographic references. I
> I see. So the workaround for those scripts which can't be
> imported is to
> start them with:
> import sys; if sys.doc_building: sys.exit()
> Not too bad.
I more had in mind:
# Normally critical we do this.
We dont need to execute the bulk of the code, just import the module
and get a few of the symbols.
> That would be written (with the current proposal):
> The following code shows how to do this:
> def foo():
> The following code shows how to do that:
> def bar():
> Is that ok w/ you?