[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH 1/5] docs/devel: document expectations for QAPI data modellin
|
From: |
Markus Armbruster |
|
Subject: |
Re: [PATCH 1/5] docs/devel: document expectations for QAPI data modelling for QMP |
|
Date: |
Fri, 10 Sep 2021 15:45:11 +0200 |
|
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) |
Daniel P. Berrangé <berrange@redhat.com> writes:
> On Thu, Sep 09, 2021 at 11:33:20AM +0200, Markus Armbruster wrote:
[...]
>> There are many existing long lines in this file, so I'm not flagging
>> yours, except for this one, because it increases the maximum.
>
> This line is at exactly 80 characters so checkstyle is happy with it.
> We don't have any requirement for a differenet line limit for docs
> afair ?
We don't. I'm asking for a favour.
Humans tend to have trouble following long lines with our eyes (I sure
do). Typographic manuals suggest to limit columns to roughly 60
characters for exactly that reason[1].
70 is a reasonable compromise between legibility and "writability". For
code, we use 80-90, because there the actual width should still be fine
due to indentation.
checkpatch.pl doesn't differentiate betwen code and prose.
This file is already hard to read for me. Please consider not making it
harder.
[1] https://en.wikipedia.org/wiki/Column_(typography)#Typographic_style
[PATCH 2/5] hw/core: introduce 'format_state' callback to replace 'dump_state', Daniel P . Berrangé, 2021/09/08
[PATCH 3/5] target/i386: convert to use format_state instead of dump_state, Daniel P . Berrangé, 2021/09/08
[PATCH 4/5] qapi: introduce x-query-registers QMP command, Daniel P . Berrangé, 2021/09/08