Вопросы по теме 'numpydoc'
Документы Sphinx для составных типов данных
Существует ли стандарт или лучшая практика в Sphinx для предоставления более точных спецификаций для составных типов данных Python? Например, у меня есть функция, которая возвращает dict , отображающую str в str , и я использую стиль numpydoc ....
628 просмотров
schedule
13.03.2023
Должны ли вы всегда документировать функции, даже если они избыточны (в частности, Python)?
Я стараюсь использовать активные и описательные имена функций, которые затем документирую активным и описательным текстом (!). Это генерирует избыточный код.
Упрощенный (но не такой уж нереалистичный) пример на питоне, следующий стилю numpy...
1309 просмотров
schedule
21.05.2022