Дорогие чуваки и программисты! Если вам не лень — гляньте пожалуйста пост в бложике про новую библиотеку мою (она ещё не релизится, и пост я этот пока не кидаю ни на какие реддиты) — понятно ли, что это и зачем? Очень ли чудовищно написано? Спасибо! http://zverok.github.io/blog/2015-10-02-readme-driven-design....
а, смысл вроде понял - очередной способ писать тесты текстом ‎- urquan
ну оно не для «всех тестов». просто всё равно ж в ридми пишут «а используется это так-то» — ну вот тут тулза + подход чтобы это упорядочить (ну и я конечно про отдельные библиотеки, не про примочки к рельсам) ‎- чаще всего просто ёбнутые
если уж вы не против обсудить библиотеку "вообще", то проблемы будут везде, где есть контекст - будь то рельсовое приложение, апи-ключи, файлы, базы и так далее. конечно, можно накрутить магии, которая этот контекст попробует создать, но стоит ли оно того? ‎- urquan
а в чём ты видишь принципиальный выигрыш перед доктестами, которые тестятся, а потом ещё и в сгенерированную документацию идут, как примеры. ‎- адский хардлайн в засаде
цель иметь up to date readme хорошая, но этого, по-моему, проще добиться двигаясь в другом направлении - генерируя его. в этом случае автор без проблем создаст контекст. ‎- urquan
@urquan ну естественно у неё есть границы применимости. но с инфобоксером оно мне очень помогло (как и помогло бы с другими моими гемами, придумай я её раньше). как и сама идея README-driven development как идея ‎- чаще всего просто ёбнутые
@larhat: а покажи, о чём речь? ‎- чаще всего просто ёбнутые
@urquan: нет, в сгенерированный ридми я не верю. документация этого типа (ридми, usage examples и т.д.) ценна именно человечностью, ткскзть желанием объяснить. ‎- чаще всего просто ёбнутые
хороший, годный подход. аналогичный подход в питоне (https://docs.python.org/2/library/doctest.html) показывает себя хорошо. ‎- 9000
@zverok ^ вот в питоне @9000 показал, или вот в rust'е очень активно применяется — https://doc.rust-lang.org/book/documentation.html#documentati... ‎- адский хардлайн в засаде
а, понял. не, это всё же про другое (хотя распространить действие dokaz'а на inline-документацию у меня есть план). это разные типы документации. грубо говоря, «как использовать библиотеку вообще» (или вот такой её аспект, вполне вероятно размазанный по нескольким модулям) vs «как использовать этот модуль/класс/функцию». нужно, естественно, и то и другое. но я же не зря блог-пост начинаю не с библиотеки, а с подхода (readme-driven development). суть в том, что когда я писал вики по инфобоксеру, этих модулей ещё не было. и более того — при сохранении описания в вики дизайн внутренних модулей и раскладка логики между ними изменились радикально раза 3-4 за время разработки. разные вещи, ну. ‎- чаще всего просто ёбнутые
ну вот в питоне у тебя есть обычно топ-левел модуль, а в расте lib.rs, где можно разместить доку про то, как вообще использовать и всё такое. этот же коммент пойдёт на главную страницу автосгенерённой документации. может действительно, как предлагает @urquan ридми сгенерить из чего-то такого? ‎- адский хардлайн в засаде
в общем, доставание примеров кода из документации и тестирование их — хорошо, какая именно документация (inline, redame, вики) — вопрос второй, но чем больше доступных форматов, тем лучше. «trying to explain to invisible reader how cool it should be some day, you are likely to come with much better and cleaner interface than “pure imagination”-driven or behavior-driven design.» — тоже всячески хорошо, но я не заметил, как именно dokaz этому помогает, кроме как тестированием. было бы любопытно ввести режим сбора предлагаемых API, который писал бы скелет без реализации. ‎- 9000
@9000: ну логика такая (зачем нужен доказ): 1. Скажем, TDD/BDD is cool — и у нас есть инструменты, чтобы написать файлы с описанием tests или behavior лаконично — и запустить их на проверку. 2. Предположим, RDD is cool — и вот инструмент чтобы описать всё в ридми и отправить на проверку. as simple as that. ‎- чаще всего просто ёбнутые
бамп понедельничный (с просьбой глянуть именно сам пост, если вдруг кому не лень) с соседнем френдфиде сказали что текст такого качества вообще на публику нет смысла выкладывать (при этом первые четыре абзаца @clbn уже поправил) ‎- чаще всего просто ёбнутые