[erlang-questions] Erlang documentation -- a modest proposal
Anthony Ramine
n.oxyde@REDACTED
Thu Sep 29 01:49:36 CEST 2016
Replied inline.
> Le 29 sept. 2016 à 01:39, Richard A. O'Keefe <ok@REDACTED> a écrit :
>
>
>
> On 28/09/16 10:22 PM, Anthony Ramine wrote:
>>
>> So why do you hardwrap all your emails by hand to 50 columns? You are wasting my real screen estate. Do you hate me? :(
>
> E-mail is not documentation.
It's text. Whatever brand of text, long lines are never readable.
> As to why I do it, your unwrapped lines are truncated in my MUA.
Maybe you should use a more modern MUA that actually handles quoted-printable correctly? There is nothing wrong with my MUA nor what I send.
>> Syntax colouring of examples usually need JS because otherwise
>
> the HTML markup to be downloaded becomes really heavy.
Seems like your MUA cannot quote properly. :( Maybe update it?
> Syntax colouring is something we're better off without.
>
> Why? Because it makes *irrelevant* distinctions that are
> already apparent in the text, at the price of reducing the
> contrast, thereby making the code less readable.
>
> If syntax colouring were easily controlled by the end-user,
> that might be tolerable.
What about your students? Don't they like syntax colouring? Maybe you should just consider you are not a representative part of what developers in our current age do? I'm grumpy sometimes at what my brethren do, but I realise sometimes multiple opinions must coexist.
For syntax colouring to be easily controlled anyway, the markup would have to not include it, and thus you would still need to rely on JS.
More information about the erlang-questions
mailing list