The omission is somewhat intentional as nobody had a strong use case for
it. Specially given not using fenced blocks is more readable for those
reading the documentation inline.

Also, can I take the opportunity to do a small rant on the 80 spaces limit?
It is quite antiquated as a default. Sure, if you prefer it, then fine, but
I would not pick it as a default value. IIRC is a limit that comes from
punch cards.

Some still defend it based on typograph but those usually recommend 66CPL
as best and a maximum of 75. On the other hand, there is a study (a bit old
at this point) that measured faster reading times for eletronic
mediums with 95CPL:
https://www.researchgate.net/publication/253615156_The_Effects_of_Line_Length_on_Reading_Online_News

The paper also shows a strong preference for 35CPL!

If someone is aware of more recent studies or studies specific for
programming purposes, please let me know.

I personally prefer 95/100, as Elixir leads to horizontal code with pattern
matching, well-named variables, multiple arguments, etc. But it is a
personal preference. I wouldn't dare to argue it is an ideal value. :)

On Sunday, October 30, 2016, Chris Keele <[email protected]> wrote:

> Hey all,
>
> I'm trying to get a project into 80 character lines. Most of the credo
> violations are long ExUnit doctest lines.
>
> I notice that IO.Ansi.Docs
> <https://github.com/elixir-lang/elixir/pull/3357> and ExDoc
> <https://github.com/elixir-lang/ex_doc/pull/85> both have support for
> fenced code blocks, which I prefer in Markdown and would dedent my problem
> lines sufficiently. However, when I try to run doctests with them, I get:
>
> Doctest did not compile, got: (SyntaxError) lib/library.ex:14: unexpected
> token: "`" (column 1, codepoint U+0060)
>      code: 4
>            ```
>      stacktrace:
>        lib/library.ex:13: Library (module)
>
> Is this omission intentional, or a feature request I could hack on?
>
> --
> 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 [email protected]
> <javascript:_e(%7B%7D,'cvml','elixir-lang-core%[email protected]');>
> .
> To view this discussion on the web visit https://groups.google.com/d/
> msgid/elixir-lang-core/9560079b-c0e6-4007-9d10-
> 3850a9aa6316%40googlegroups.com
> <https://groups.google.com/d/msgid/elixir-lang-core/9560079b-c0e6-4007-9d10-3850a9aa6316%40googlegroups.com?utm_medium=email&utm_source=footer>
> .
> For more options, visit https://groups.google.com/d/optout.
>


-- 


*José Valim*
www.plataformatec.com.br
Skype: jv.ptec
Founder and Director of R&D

-- 
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 [email protected].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/elixir-lang-core/CAGnRm4%2B4pMH25DMr_tKL0_SrFGVjnuhP%3DoBe-3Tf7pY4%3DvMFvA%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to