How to understand pydoc parameters in documentation

Question

I was looking up seek() in pydoc file and found the explanation on what the function does, but I didn't understand how the documentation states the parameters. It looked like this:

seek(offset[, whence])

At first I thought it was a parameter in a parameter but it obviously isn't. What do those brackets denote in the parameter fields?

Possible duplicate of How to read API documentation for newbs? — Bergi
– Bergi, Commented Nov 4, 2018 at 19:14

Polyana Fontes · Accepted Answer · 2012-12-15 16:53:22Z

1

everything that is between [ and ] are optional

in this case you can call:

seek(offset)

or

seek(offset, whence)

answered Dec 15, 2012 at 16:53

Polyana Fontes

3,2221 gold badge30 silver badges43 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to understand pydoc parameters in documentation

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related