docstring of method

[ShvarcbergJull]

оформление docstrings для методов и функций в следующем виде:

"""
My numpydoc description of a kind
of very exhautive numpydoc format docstring.

Parameters
----------
first : array_like
    the 1st param name `first`
second :
    the 2nd param
third : {'value', 'other'}, optional
    the 3rd param, by default 'value'

Returns
-------
string
    a value in a string

Raises
------
KeyError
    when a key error
OtherError
    when an other error
"""

• если ничего не возвращается то либо нет раздела Returns, либо в нём None:

  Returns
  -------
  None

• Raises указывать при необходимости

[nicl-nno]

@DenisSidoren а это правильный формат докстрингов для построения документации?

[DenisSidoren]

@nicl-nno Формат (стиль) докстрингов может быть разный, в данном случае используется numpy-style, при правильной настройке конфиг файла отображение документации будет корректным и, возможно, красивым - зависит от того, что является красивым. В тех проектах, где я оформлял документацию я выбирал google-style докстринги, этот стиль было проще и удобнее использовать, чтобы конечный продукт выглядел достойно