170 похожих чатов

А как подать свой pep? Я тоже подам что инофрмацию

из докстринг надо хранить упорядоченно в файле help.md, который бы в итоге компилировался в нормальную такую человекочитаемую документацию.

11 ответов

9 просмотров

а в чем проблема компилировать доку сфинксом сейчас?

Nastya-Medveda Автор вопроса
Tishka17
а в чем проблема компилировать доку сфинксом сейча...

В том, что я предлагаю наоборот. Мы делаем упорядоченную доку, а докстринги IDE привязыает в функцию из этой доки .

Nastya Medveda
В том, что я предлагаю наоборот. Мы делаем упорядо...

сфикс это и так умеет, но не факт что IDE умеют дергать документацию из документации сфинкса.

Nastya-Medveda Автор вопроса
Tishka17
и получаем два источника правды

Нет, мы не пишем докстринги в py файлах вообще. Вместо этого мы используем кавычки для многострочных комментариев.

Nastya Medveda
В том, что я предлагаю наоборот. Мы делаем упорядо...

Тут прямо в том же файле регулярно кто-нибудь забывает докстринг обновить. Прикинь как это будет весело, если оно размазано по нескольким источникам, и только определённые IDE костылями (плагинами) объединяет всё это в кучу. В чём профит?

evle
Тут прямо в том же файле регулярно кто-нибудь забы...

Поэтому нужно в докстрингах писать ещё и доктесты, и покрытие считать, чтобы не забывали их добавлять

Andrey
Поэтому нужно в докстрингах писать ещё и доктесты,...

Ну, тесты всё-таки отдельный вид деятельности. Хотя такой подход иногда и применялся, с ним есть проблема — тестов дофига, они загромождают код и при этом напрямую с кодом не особо сильно связаны. Можно б было уложить все тесты в экран — можно было бы так и делать.

Похожие вопросы

Обсуждают сегодня

А еще в перле можно уже @arr1 + @arr2?
Sergei Zhmylove
53
Подскажите, где смотреть результат выполнения программы? Код: ;.686 ;Система команд процессора 686 ;.MODEL FLAT,stdcall ;Модель памяти плоская, станда...
Егор Анелькин
5
я не магистр хаскеля, но разве не может лейзи тип конвертнуться в не-лейзи запросив вычисление содержимого прям при инициализации?
deadgnom32 λ madao
100
Привет всем. появился вопрос. Разрабатываю сайт, в данный момент он запущен. Хостинг beget. Добавляю на сайт яндекс метрику с помощью полей client-settings (взято отсюда http...
Andrew
2
;.686 ;Система команд процессора 686 ;.MODEL FLAT,stdcall ;Модель памяти плоская, стандартный ;вызов процедуры ;option casemap:no...
Егор Анелькин
1
Так а кто может спарсить всех участников чата? Идишники
Magic
17
Есть вопрос: допустим есть железка с каким-то интерфейсом(допустим usb), но как по этому интерфейсу железкой управлять неизвестно, прог нету, а управлять очень хочется надо. К...
Mixail Frolov
15
а как ловят такое ghci> res <- getPos2 urlt 0 (alist !! 0) 200 ghci> res SearchAtom (Search "www.google.com" "/search?q=" "Haskell") "haskell.org" (SearchTS [(2024-05-06 07:...
Fedor
14
всем привет почти закончил курс После него можно писать свою операционку? Какие библиотеки надо использовать и куда дальше копать для изучения
Linus
13
Ребята, а из API геокодеров (по адресам в РФ) что сейчас актуального и есть ли среди актуального бесплатное/с нормаотным лимитом запросов? ситуация простая - на сайте периоди...
Dreamer_0x01 VeseloV
8
Карта сайта