Message95903
import builtins; help(builtins)
Looking around, the new suggestion is absolutely unconventional. The
signature must be on the first line. One builtin function even uses two
lines; min:
min(iterable[, key=func]) -> value
min(a, b, c, ...[, key=func]) -> value
With a single iterable argument, return its smallest item.
With two or more arguments, return the smallest argument.
I would ack a two-line signature at the start of the docstring, however
I will also suggest an alternative:
Aligning open's signature description with the builtins module, this is
the style that is most common:
open(file[, mode[, buffering[, encoding[, errors[, newline[,
closefd]]]]]]) -> file object
perhaps even an abbreviation is allowed at the end?
open(file[, mode[, buffering[, encoding[, errors[, newline[,
closefd]..]) -> file object
However that open has so many kwargs should almost be a bug in itself. |
|
Date |
User |
Action |
Args |
2009-12-02 13:12:13 | englabenny | set | recipients:
+ englabenny, georg.brandl, pitrou, flox |
2009-12-02 13:12:12 | englabenny | set | messageid: <1259759532.86.0.372650893421.issue7417@psf.upfronthosting.co.za> |
2009-12-02 13:12:11 | englabenny | link | issue7417 messages |
2009-12-02 13:12:10 | englabenny | create | |
|