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