[Doc-SIG] Proposal: don't nest optional brackets

Paul Moore p.f.moore at gmail.com
Fri Jun 20 14:51:36 CEST 2008

On 20/06/2008, A.M. Kuchling <amk at amk.ca> 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.


More information about the Doc-SIG mailing list