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

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

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

11 ответов

25 просмотров

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Господа, а что сейчас вообще с рынком труда на делфи происходит? Какова ситуация?
Rꙮman Yankꙮvsky
29
А вообще, что может смущать в самой Julia - бы сказал, что нет единого стандартного подхода по многим моментам, поэтому многое выглядит как "хаки" и произвол. Короче говоря, с...
Viktor G.
2
30500 за редактор? )
Владимир
47
а через ESC-код ?
Alexey Kulakov
29
Чёт не понял, я ж правильной функцией воспользовался чтобы вывести отладочную информацию? но что-то она не ловится
notme
18
У меня есть функция где происходит это: write_bit(buffer, 1); write_bit(buffer, 0); write_bit(buffer, 1); write_bit(buffer, 1); write_bit(buffer, 1); w...
~
14
Добрый день! Скажите пожалуйста, а какие программы вы бы рекомендовали написать для того, чтобы научиться управлять памятью? Можно написать динамический массив, можно связный ...
Филипп
7
Недавно Google Project Zero нашёл багу в SQLite с помощью LLM, о чём достаточно было шумно в определённых интернетах, которые сопровождались рассказами, что скоро всех "ибешни...
Alex Sherbakov
5
Ребят в СИ можно реализовать ООП?
Николай
33
https://github.com/erlang/otp/blob/OTP-27.1/lib/kernel/src/logger_h_common.erl#L174 https://github.com/erlang/otp/blob/OTP-27.1/lib/kernel/src/logger_olp.erl#L76 15 лет назад...
Maksim Lapshin
20
Карта сайта