Re: Proposal: don't nest optional brackets

"Paul Moore" <[email protected]>
Newsgroups gmane.comp.python.documentation
Message-ID <[email protected]>
On 20/06/2008, A.M. Kuchling <[email protected]> wrote:
> My proposal is that we drop the nesting and write this as:
>
> warnings.filterwarnings(action [, message, category, module, lineno, append])
[...]
> What does everyone think?

Sounds OK to me - this is documentation, not a formal spec, so
readability is more important than absolute precision.

I wonder - what do other projects do? Consistency with common practice
is likely to help readability, as well.

Paul.
_______________________________________________
Doc-SIG maillist  -  [email protected]
http://mail.python.org/mailman/listinfo/doc-sig
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.