Names that look like
numpy.arrayare links to detailed documentation.
Examples often include the Python prompt
>>>. This is not part of the code and will cause an error if typed or pasted into the Python shell. It can be safely typed or pasted into the IPython shell; the
Examples often use
npas an alias for
numpy; that is, they assume you’ve run:
>>> import numpy as np
If you’re a code contributor writing a docstring, see Docstrings.
If you’re a writer contributing ordinary (non-docstring) documentation, see User documentation.