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

А что в "нормальном ридми" быть должно? описать что это

такое, накидать пару кратких примеров вдобавок к тем, что есть в отдельной папке, вынести в отдельный док инструкции по установке (пока я в pypi это все не залил)... больше ничего в голову не приходит

2 ответов

3 просмотра

Не знаю, как другие, а я в readme ожидаю полное описание всего API библиотеки. Каждый метод с коротким примером, относящийся именно к методу. Разбирать огромную простыню в файле с примером буду только от безысходности, если других библиотек нет.

Представь ситуацию, когда ты купил сложный прибор без инструкции. Будешь ли ты доволен тратить время на выяснение того, что можно было бы просто прочитать. Вот там должно быть все, чтобы понять что это, как этим пользоваться и зачем это вообще нужно. Маркетинг никто не отменял

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

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

Типа вызывать GetParent и проверять на соответствие GetModuleHandle?
The Bird of Hermes
67
Do any of you guys have interesting projects one could join? I'm a Middle Full-Stack developer (JS/TS, React & Node)
Lev Shapiro
40
$res = json_decode($наша строка из респонса); $res1 = array_map(fn($o) => $o->name, $res->breadcrumbs[0]->entities); Как такое будет на Хаскеле?.. В начале весь джейсон, в ко...
Хаскель Моисеевич Гопник
27
В чем сила брат, в NASM или FASM?
Isaac Kleiner
18
Вопрос по диагностике ошибок (я знаю в чем, в данном конкретном примере, я знаю, как исправить, пример модельный, понятно, что в реальности бывает намного запутаннее). module...
ⰄⰎⰋⰐⰐⰑⰛⰤⰧⰧⰩⰄ ⰊⰑⰁⰓⰡⰛⰦⰕⰫ
11
А чем вам питонисты не угодили?😂
.
79
Хтось використовував Vapor на Windows?
Jaroshevskii
15
Есть какой-нибудь для Delphi/FPC T*Compression(Decompression)Stream на базе LZ4/Zstd/любой другой быстрый(и хорошо сжимающий) алгоритм А ещё лучше в pure pascal А ещё лучше од...
notme
52
Тут кста кто-нибудь NeoVim использует?
Simple Sorcerer
13
Какое виндузовое сообщение приходит TTabSheet, что риэлайняться контролы на нем, даже у которых парент другой? Ситуация: открываю форму - кнопок нет, перелистываю на другой т...
Катерина Свиридова
7
Карта сайта