Hi all,
Since documentation is taken seriously in Elixir,
I would like to propose to emit a warning when a public function
does not a have a proper/complete function signature.
I describe an improper fucntion signature would look like this in your
IEx/ExDoc documenation:
your_function_name(arg1, arg2, options)
This is do to the fact of not using argument names in your function
definitions, for example:
def your_function_name(10, 20, options) when is_list(options),
do: ...
As of now, IEx and ExDoc do a good job as guessing these signatures,
based on the function argument names of the various function clauses
when they are not explicitely declared,
but I would like Elixir to emit a warning when it will end up looking
like `argX`.
We could introduce this feature as a flag:
--warn-on-imcomplete-signature
And eventually make it by default.
As of now, in order to avoid this, I need to execute: `mix docs` and
then grep the doc/ folder looking for `argX` with a ·
This feature will integrate well with `--warnings-as-errors` and CI to
help to maintain up a high standard in the documentation of our
libraries.
Looking forward to hearing your opinion,
- Eksperimetnal
--
You received this message because you are subscribed to the Google Groups
"elixir-lang-core" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to elixir-lang-core+unsubscr...@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/elixir-lang-core/61bf2760.1c69fb81.edfdb.56f2SMTPIN_ADDED_MISSING%40gmr-mx.google.com.
