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

React — русскоговорящее с... React — русскоговорящее с...
Android Developers Android Developers
Python Python
Vue.js — русскоговорящее ... Vue.js — русскоговорящее ...
supapro.cxx supapro.cxx
DotNetRuChat DotNetRuChat
GNU/Linux Help GNU/Linux Help
Telegram Developers Telegram Developers
Node.js — русскоговорящее... Node.js — русскоговорящее...
DevOps — русскоговорящее ... DevOps — русскоговорящее ...
JavaScript Noobs — сообще... JavaScript Noobs — сообще...
Django [ru] Django [ru]
Go-go! Go-go!
Angular - русскоговорящее... Angular - русскоговорящее...
ntwrk ntwrk
Верстка сайтов HTML/CSS/J... Верстка сайтов HTML/CSS/J...
phpGeeks phpGeeks
Kubernetes — русскоговоря... Kubernetes — русскоговоря...
Битрикс для разработчиков Битрикс для разработчиков
MODX. Русскоязычное сообщ... MODX. Русскоязычное сообщ...
pgsql – PostgreSQL pgsql – PostgreSQL
Laravel Pro Laravel Pro
iOS Developers — русского... iOS Developers — русского...
ClickHouse не тормозит ClickHouse не тормозит
Rust — русскоговорящее со... Rust — русскоговорящее со...
JavaScript — русскоговоря... JavaScript — русскоговоря...
С# С#
pro.cxx pro.cxx
pro.jvm pro.jvm
React Native — русскогово... React Native — русскогово...
Devs Chat Devs Chat
Docker — русскоговорящее ... Docker — русскоговорящее ...
HTML/CSS — русскоговоряще... HTML/CSS — русскоговоряще...
Python beginners Python beginners
🐧 RU.UBUNTU — Официальное... 🐧 RU.UBUNTU — Официальное...
Kotlin Community Kotlin Community
Embedded Group Embedded Group
Чат экстремального погром... Чат экстремального погром...
aiogram aiogram
Scala User Group Scala User Group
Haskell Haskell
PHP PHP
TypeScript TypeScript
Клуб Vue.js-разработчиков Клуб Vue.js-разработчиков
Xamarin Developers (MAUI,... Xamarin Developers (MAUI,...
F# Chat F# Chat
Svelte [svelt] - All abou... Svelte [svelt] - All abou...
Системное администрирован... Системное администрирован...
Nuxt.js | Vue SSR Nuxt.js | Vue SSR
var chat = new Chat(); var chat = new Chat();
Data Science Chat Data Science Chat
Ассемблер Ассемблер
Android Architecture Android Architecture
Laravel для начинающих Laravel для начинающих
Церковь метрик Церковь метрик
Dart & Flutter Dart & Flutter
QA — русскоговорящее сооб... QA — русскоговорящее сооб...
Tarantool Tarantool
pro.elixir pro.elixir
Python Flask Python Flask
SAP ABAP SAP ABAP
R (язык программирования) R (язык программирования)
learn.java learn.java
DevsHelper DevsHelper
Big Data Science :: AI / ... Big Data Science :: AI / ...
Delphi & Lazarus Delphi & Lazarus
SwiftBook SwiftBook
Solidity Development Solidity Development
Evolution CMS официальное... Evolution CMS официальное...
pro.net (former COM+) pro.net (former COM+)
OpenStreetMap RU OpenStreetMap RU
Visual Studio Code — русс... Visual Studio Code — русс...
ru_mysql ru_mysql
pro.lua pro.lua
Dart / Flutter Dart / Flutter
GraphQL — русскоговорящее... GraphQL — русскоговорящее...
pro.Asm pro.Asm
IDE и редакторы — русског... IDE и редакторы — русског...
OpenCartForum - 🇺🇦🇪🇺Чат O... OpenCartForum - 🇺🇦🇪🇺Чат O...
Angular.js (1.x) — русско... Angular.js (1.x) — русско...
Frontend_ru Frontend_ru
Lame C Lame C
Flutter Developers — русс... Flutter Developers — русс...
AutoIT RU AutoIT RU
AI / Искусственный Интелл... AI / Искусственный Интелл...
dlang.ru dlang.ru
Laravel Framework Russian... Laravel Framework Russian...
WebPwnChat WebPwnChat
Чат — Верстка Сайтов и Фр... Чат — Верстка Сайтов и Фр...
pro.python pro.python
Java Underground Java Underground
Natural Language Processi... Natural Language Processi...
javascript_ru javascript_ru
SqlCom.ru - сообщество MS... SqlCom.ru - сообщество MS...
Cinema 4D Cinema 4D
Delphi Community Delphi Community
pro.vim pro.vim
Server Side Swift Develop... Server Side Swift Develop...
Autohotkey_RU ( v1 & v2 ) Autohotkey_RU ( v1 & v2 )
PHP DevConf KZ🇰🇿 PHP DevConf KZ🇰🇿
Modern::Perl Modern::Perl
pro.rb (Ruby/Rails / RU) pro.rb (Ruby/Rails / RU)
RubyRush.ru RubyRush.ru
Oracle RU Oracle RU
ru.nim.talks ru.nim.talks
DevOps DevOps
Odoo talks & fun Odoo talks & fun
Software Design/Architect... Software Design/Architect...
sql_ninja sql_ninja
AndroidDev Pro:: Професси... AndroidDev Pro:: Професси...
WordPress for developers WordPress for developers
PowerShellRus - о Powersh... PowerShellRus - о Powersh...
Haskell Start Haskell Start
Эльбрусы и с чем их едят Эльбрусы и с чем их едят
Java/Kotlin and more Java/Kotlin and more
pro.buildsystems pro.buildsystems
Powershell Rus Powershell Rus
ErlangRus ErlangRus
Python для анализа данных Python для анализа данных
Скрипты Гугл, Таблицы, Go... Скрипты Гугл, Таблицы, Go...
WebGL ru WebGL ru
Compiler Development Compiler Development
firebase_ru — русскоговор... firebase_ru — русскоговор...
Electron.js Electron.js
phpclub.ru phpclub.ru
RU.CRYPTOGRAPHY — Криптог... RU.CRYPTOGRAPHY — Криптог...
pro.osdev - os developmen... pro.osdev - os developmen...
MySQL MySQL
Lame C++ Lame C++
QA juniors QA juniors
GameDev for Web GameDev for Web
Go Get A Job Go Get A Job
PostgreSQL (English) PostgreSQL (English)
Ember_js Ember_js
Tilda Developers Tilda Developers
RU.Docker — Официальное Р... RU.Docker — Официальное Р...
Emacs — русскоговорящее с... Emacs — русскоговорящее с...
FreePascal & Lazarus FreePascal & Lazarus
Язык программирования Jul... Язык программирования Jul...
WordPress – русскоговорящ... WordPress – русскоговорящ...
Django Django
sentry_ru sentry_ru
ReasonML и OCaml ReasonML и OCaml
WebAssembly — русскоговор... WebAssembly — русскоговор...
ansible — русскоговорящее... ansible — русскоговорящее...
Сrystal Lang — русскогово... Сrystal Lang — русскогово...
aiohttp aiohttp
Clojure — русскоговорящее... Clojure — русскоговорящее...
heroku_ru heroku_ru
PowerShell Pro PowerShell Pro
macOS Developers — русско... macOS Developers — русско...
systemd systemd
use Perl or die; use Perl or die;
FORTH и родственные ЯП FORTH и родственные ЯП
Natural Language Processi... Natural Language Processi...
ru_jenkins ru_jenkins
CatBoost CatBoost
CyberBiology CyberBiology
Sequelize - community (en... Sequelize - community (en...
sonarqube_ru sonarqube_ru
Elm Lang сообщество разра... Elm Lang сообщество разра...
SublimeText_RU SublimeText_RU
NativeScript NativeScript
WordPress CodeRun WordPress CodeRun
ReactiveX - русскоговорящ... ReactiveX - русскоговорящ...
PureScript — русскоговоря... PureScript — русскоговоря...
#Вайти #Вайти
Эликсир и Вунш Эликсир и Вунш
Cassandra Cassandra
pro.elixir pro.elixir
Սուրեն-Կիրակոսյան

Кто может помочь советами по "теория написании документации в Elixir"?

Тут вообщем очень простая ситуация:
Есть функция в модуле. Эта функция получает получает параметры и возвращает значение. Если параметров много или мало, то возвращается :error, иначе функция выполнятся. Во время выполнение получение параметры могут не соответствовать условию, в этом случаи так же возвращается :error. Если всё правильно, то возвращается тупл с атомом и мапом. Я посмотрел в нескольких исходниках, в каких-то статьях, но так и до конца не понял: мне стоит описывать каждый случай вызома, скажем с правильным количество параметров и неправильным, с правильными входящими данными и с неправильными, или хватит всего один пример?

Как вы это обычно делаете?

#elixir #programming #russian
0

14 ответов

14 просмотров
Обыкнoвeнный челoвeк-

давай по пунктам: 1. Если передаваемые параметры не соответствуют арности вызываемой ф-ции, то выбросится соответствующее исключение. 2. "не соответствует условию" - речь о guards?

0
18.01.2021
Սուրեն-Կիրակոսյան Автор вопроса
Обыкнoвeнный челoвeк
давай по пунктам: 1. Если передаваемые параметры н...

1. Исключение выбрасывается(в виде атома error), но стоит ли эту часть тоже включать в докементацию? 2. Нет, просто bad requst/invalid inputs, что-то такое.

0
18.01.2021
Anastasiya-Dyachenko

мне обычно хватает spec с перечислением всех возможных результатов, но это подразумевает что ошибки говорят сами за себя, например user_not_found, invalid_id. Если ошибки неоднозначные, то можно в комментарии перечислить все возможные ошибки списком и кратко описать что они значат.

0
18.01.2021
Սուրեն-Կիրակոսյան Автор вопроса
Anastasiya Dyachenko
мне обычно хватает spec с перечислением всех возмо...

Ясно, значит увлекаться с написанием документации не стоит.

0
18.01.2021
Anastasiya-Dyachenko
Սուրեն Կիրակոսյան
Ясно, значит увлекаться с написанием документации ...

не ну если пишешь опен сорс либу то лучше более подробно писать документацию, если для себя и команды - то нет необходимости

0
18.01.2021
Սուրեն-Կիրակոսյան Автор вопроса
Обыкнoвeнный челoвeк
👌 очень полезное увлечение.

Я имел ввиду описание многих вариантов вызова этой функции и возвращаемого результата, как это делаем в тестах.

0
18.01.2021
Радж-Полиновский
Anastasiya Dyachenko
не ну если пишешь опен сорс либу то лучше более по...

Есть необходимость ) Потом через полгода, если нужно что-то изменить, смотришь на код как первый раз )))

0
18.01.2021
Anastasiya-Dyachenko
Радж Полиновский
Есть необходимость ) Потом через полгода, если нуж...

если видя внутренности сложно понять что делает код, то код не очень)

0
18.01.2021
Maksim-Lapshin
Anastasiya Dyachenko
если видя внутренности сложно понять что делает ко...

Вопрос не «что делает код», а «зачем» и «какие еще входные параметры тут могут быть»

0
18.01.2021

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

pro.elixir pro.elixir / Д. П.
Подписаться

А кто-нить эмулировал hackney в тестах? Я хочу сгенерить ответ с client_ref, но что-то ерунду пишу всё время. При ответе он возвращает {:ok..... client_ref}, который надо body...

#elixir #programming #russian
01.08.2023
0
30 ответов
pro.elixir pro.elixir / Vihtor
Подписаться

Коллеги, подскажите, отличается ли как-то принципиально архитектура/паттерны классического SaaS проекта(web app, api, webhooks, periodic jobs, workflows, etc) на Elixir/Phoeni...

#elixir #programming #russian
31.05.2023
0
25 ответов
pro.elixir pro.elixir / Ivan Lukov
Подписаться

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

#elixir #programming #russian
23.11.2023
0
11 ответов
pro.elixir pro.elixir / Alex Georgiev
Подписаться

Ребят, привет! может немного не в тему но все же. Сейчас пишу бэк на питоне, хочу освоить написание бэка еще на каком-нибудь ЯП. Думаю между ruby и elixir. Можете что-то посов...

#elixir #programming #russian
20.07.2023
0
24 ответов
pro.elixir pro.elixir / heathen
Подписаться

Любопытно, научатся ли эйчары когда-нибудь писать зарплатные вилки в вакансиях? 🔌

#elixir #programming #russian
16.10.2023
0
20 ответов
pro.elixir pro.elixir / Alexey Novoselov
Подписаться

Айти – это работа для сумасшедших. Это чумной барак для всех умалишенных. Для фриков и психопатов. Если ты видишь маньяка, орущего на шизофреника, знай, прогадать невозможно,...

#elixir #programming #russian
24.06.2022
0
6 ответов
pro.elixir pro.elixir / Сергій
Подписаться

Кто подскажет, как сделать из макроса метод по умолчанию ? Например что б вот ето работало: defmodule MyLib do defmacro __using__(_opts) do quote do def call(pay...

#elixir #programming #russian
23.08.2023
0
19 ответов
pro.elixir pro.elixir / Дмитрий Перцев
Подписаться

Кто-нибудь, случайно, в курсе, как уменьшить аппетиты BEAM по памяти? А то у меня простое приложение в :erlang.memory(:total) показывает 54877864, а VIRT памяти сжирает 4 гига...

#elixir #programming #russian
29.08.2023
0
21 ответов
pro.elixir pro.elixir / Eugene Batogov
Подписаться

Друзья всем привет! Мы снова ищем Elixir-разработчика. Описание вакансии тут: https://hh.ru/vacancy/83458243?hhtmFrom=employer_vacancies&customDomain=1 Кому интересно - откли...

#elixir #programming #russian
17.07.2023
0
22 ответов
pro.elixir pro.elixir / Андрій
Подписаться

Привет, стоит ли делать файловый сервер на эликсире на протоколе webDAV или s3? Будет ли он эффективней питона в этом плане?

#elixir #programming #russian
08.11.2023
0
16 ответов
Смотреть еще
pro.elixir pro.elixir
Подписаться
Вопросов 9218
Ответов 16773
Участников 1211
Telegram @proelixir

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

Господа, а что сейчас вообще с рынком труда на делфи происходит? Какова ситуация?
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
Карта сайта