Types are not defined for *args and **kwargs, but mustīe defined for all other parameters. Note that the space between the name and theĬolon is important. The parameters are defined by their name, followed by a space, a colon, another A blank line is left before the section title, but notĪfter, and not between the line with the word “Parameters” and the one withĪfter the title, each parameter in the signature must be documented, including The title “Parameters”, followed by a line with a hyphen under each letter of The details of the parameters will be added in this section. The index level will be automatically removed from the index when added as columns.

This is especially useful when a subindex is repeated for the main index, and data is easier to visualize as a pivot table. When using a MultiIndex, a level can be pivoted so each value in the index becomes a column. os,Ī pandas class (in the form :class:`pandas.Series`)Ī pandas method (in the form :meth:``)Ī pandas function (in the form :func:`pandas.to_datetime`)ĭef unstack (): ''' Pivot a row index to columns. Python code, a module, function, built-in, type, literal… (e.g. The following are considered inline code:

On rare occasions reST styles like bold text or italics will be used inĭocstrings, but is it common to have inline code, which is presented betweenīackticks. (meaning that they are not at the end of the last sentence). The text starts in the next line after the Writing a docstring ¶ General rules ¶ĭocstrings must be defined with three double-quotes. Provide additional conventions specific to the pandas project. The rest of this document will summarize all the above guidelines, and will Pandas has some helpers for sharing docstrings between related classes, see Language that allows encoding styles in plain text files. The standard uses reStructuredText (reST). Numpydoc is a Sphinx extension to support the NumPy docstring convention. (which is based in the original Guide to NumPy/SciPy documentation) In theĬase of pandas, the NumPy docstring convention is followed. The first conventions every Python docstring should follow are defined inĪs PEP-257 is quite broad, other more specific standards also exist. Some standards regarding docstrings exist, which make them easier to read, and allow themīe easily exported to other formats such as html or pdf. See Also - subtract : Subtract one integer from another. Returns - int The sum of ``num1`` and ``num2``. Parameters - num1 : int First number to add. This function simply wraps the ``+`` operator, and does not do anything interesting, except for illustrating what the docstring of a very simple function looks like. Def add ( num1, num2 ): ''' Add up two integer numbers.

Snippit function has not been defined