Да, я неправильно прочитал.. не учёл имени.

в личку боту надо писать

он отвечает

Может допилить чтобы и так отвечал?)

Походу чат будет засорятся...

А вот вопрос созрел: есть приватные функции, хочу к ним добавить доку. На @doc диалайзер ругется, что для приватных функций док не нужен. Как тут быть?

просто добавить комментарий)

ну как-то это не красиво

Наверное слишком много делаешь в приватных функциях

нет не много

Обычно хватает описания публичных

хочется чотбы код выглядел едиообразно

если док, то у всех одинакого

ну, приватные и публичные функции - разные

@doc - это описание интерфейса

описывается только публичный интерфейс

‾\_(ツ)_/‾

мда...

складывается ощущение, что приватная функция и не функция вовсе...

Если описания публичного интерфейса не хватает для достаточно полной документации модуля - скорее всего проблема в организации кода

и модуль делает больше, чем он должен делать

складывается ощущение, что приватная функция и не функция вовсе...

так и есть https://elixirforum.com/t/proposal-docp-for-private-function-documentation-and-doctests/3732/2

ну и приватные функции не тестируются

я это читал

но дока нужна для будущих поколений доработчиков

мне и так все понятно

придётся просто комментом сделать

хотя фигня это какая-то

тем не менее иногда документировать надо, согласен, что бы тут не говорили. но только простые комменты

вообще логично. в принципе это аргумент к тому что приватные функции должны быть написаны максимально прозрачно и понятно

придётся просто комментом сделать

Все приватные функции можно разместить в вспомогательном модуле и сделать их публичными

Тогда сможешь их и тестировать, и документировать

Чем комментарии к коду не документация?

Можно и часть функции задокументировать и вообще все, что угодно обычными комментариями.

Чем комментарии к коду не документация?

?

Чем комментарии к коду не документация?

В красивую html’ку не собираются)

Все приватные функции можно разместить в вспомогательном модуле и сделать их публичными

извращение какое-то, а если немного изменишь приватные функции не меняя публичную функцию

извращение какое-то, а если немного изменишь приватные функции не меняя публичную функцию

никакого извращения, один из подходов к разработке

В красивую html’ку не собираются)

Зачем собирать приватные функции в html???

приватные функции нужны для атомарных действий и называться соответственно, и дока не нужна будет

приватные функции нужны для атомарных действий и называться соответственно, и дока не нужна будет

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

приватные функции нужны для атомарных действий и называться соответственно, и дока не нужна будет

К приватным функциям нужна документация, но достаточно комментариев.

если нельзя так сделать(написать доку, тестить) то может и не надо

это дизайн языка

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

я в начале тоже пыталась тестить каждую функцию и пришла к тому что это реально лишнее

Очень странно постороннему человеку слышать, что приватные функции нельзя тестить по дизайну языка..

в то же время это не дока

А если там основной функцонал ?

Документация кода для разработчиков этого же проекта, т.е. документация, но совершенно другого уровня.

Не требующая ни html, ни того, чтобы ее кто-то видел извне.

ERROR: S client not available

А если там основной функцонал ?

этот основной функционал вызывают публичные функции, вот их и тестить

@doc это генератор документации, никто не мешает писать обычные комментарии

этот основной функционал вызывают публичные функции, вот их и тестить

Полностью согласен ?

Документация к приватным функциям нужна только для тех, кто разрабатывает этот проект и соответственно заглядывает внутрь проекта, т.е. смотрит внутрь. Никто извне не должен ничего знать о приватных функциях - соответственно оно не должно попадать во внешнюю документацию.

https://github.com/ExpressApp/ecto_crdt_types ещё немножко выложили в опенсорс

в hex правда пока не выкладывал...

что такое crdt?

что такое crdt?

conflict replicated data types

*conflict-free точнее

https://en.m.wikipedia.org/wiki/Conflict-free_replicated_data_type

если в комментах не нравится описывать, то всегда можно сделать раздел в @moduledoc

и описать там

Привет, Effie! Пожалуйста, реши капчу: Вычисли: 25+75=... Осталось попыток: 3 Если не решишь - забаню навеки... Удачи!

Привет, Colleen! Пожалуйста, реши капчу: Вычисли: 94+90=... Осталось попыток: 3 Если не решишь - забаню навеки... Удачи!

Всем привет! Нам требуется ваша помощь в развитии русскоязычного Эликсир-сообщества. Для этого вам нужно приложить минимум усилий и просто заполнить небольшую анкету https://connect.yandex.ru/forms/5b924103d9085801d3d2d6bc/ Пожалуйста, не поленитесь: поставьте дела на паузу и прямо сейчас пробегитесь по вопросам. Иначе забудете или забьёте. А важен каждый отзыв. И твой особенно!

Опять яндекс ?

а он теперь не в фаворе? лет 6 назад яндекс и добро были синонимами

не, вполне нормальный сервис только он из Украины заблокирован

не, вполне нормальный сервис только он из Украины заблокирован

А впн зачем??

Я врубил впн и прошел тест)

Походу это было для избранных Российских чуваков. Или вы планировали ехать на митап в Питер из Харькова?) Ну если планировали - вопрососв нет, конечно...

Далековато лететь :)

упс

?