[Tutor] Python Documentation Clarification

[Adam Bark]

On 12 July 2010 15:49, Huy Ton That <huyslogic at gmail.com> wrote:

> This is going to sound silly, but I realized there are some areas within
> the documentation that do not make absolute sense to me.
>
> e.g.
>
> compile(source, filename, mode[, flags[, dont_inherit]])
>
> I see within this built in function, the first argument can be what they
> define as source, the second argument as the filename and the third as the
> mode.
>
> But what confuses me is sometimes I see a bracket, above as [, flags[,
> dont_inherit]]. Is this an optional argument like flags=dont_inherit?
>
> Just not grokking it correctly and I can't seem to track down where the
> documentation formatting is defined within the python.org documentation...
>
>
You're about right really, it's a keyword argument which means it will have
a default so you can specify it or leave the default by ignoring it.

HTH,
Adam.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/tutor/attachments/20100712/166e603d/attachment.html>