[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [ft-devel] Documentation guidelines file
From: |
Werner LEMBERG |
Subject: |
Re: [ft-devel] Documentation guidelines file |
Date: |
Thu, 30 Aug 2018 13:25:42 +0200 (CEST) |
> If you take
> https://raw.githubusercontent.com/freetype/freetype2-testing/master/fuzzing/README.md
> as an example (I know it's markup, but still), "hard 72" (or 78 for
> that matter) has/would have several impacts:
Well, tabular material, URLs, etc. can't be represented within 78
lines in many situations. This is a different situation. But even
here it is often possible to avoid too wide tables by some splitting.
> (2) Deeper nested lists can suffer from rigorous restrictions like
> these as every indentation cuts off a piece of the cake.
I was told that using too deep lists is bad. In most cases it isn't
necessary, and alternative representations are to be preferred. :-)
> Maybe something like "lines of straight text should not exceed X but
> the total width of a line of code should stay within Y" (e.g. X =
> 78, Y = 120 (which is still too narrow for the shown tables in my
> example but would probably work for most cases))
Mhmm, maybe
The line length of normal paragraphs of text shouldn't exceed
78 characters. Tabular material, URLs, etc. are exceptions to that
rule. If possible, avoid too wide tables and lists with too many
nesting levels. In most cases, this can be split into smaller, more
legible parts.
Werner