diff options
| author | G. Branden Robinson <g.branden.robinson@gmail.com> | 2023-01-05 16:52:35 -0600 |
|---|---|---|
| committer | Alejandro Colomar <alx@kernel.org> | 2023-01-07 00:21:53 +0100 |
| commit | 2cb6c290b18d05daeee155012707b4249bb4d566 (patch) | |
| tree | 9f26480c6dccc966bcfbac2a242aa2f751b8f186 /man3/stdio_ext.3 | |
| parent | 97d377577407b1fd79da6acd4e1c10d047aca097 (diff) | |
| download | man-pages-2cb6c290b18d05daeee155012707b4249bb4d566.tar.gz | |
ldconfig.8: wfix
* Promote a parenthetical to primary discussion. 64-bit systems are the
norm nowadays.
* Perform a Kemper notectomy. That is, stop saying "note that"
followed by some declarative statement. This trope is all over Unix
documentation and I even see it in ISO standards. The latter doesn't
serve to recommend it; as Dave Kemper has pointed out, everything we
put in technical documentation should be worthy of note unless placed
in a footnote, marked as "unnecessary on a first reading", or similar.
It is the exception, not the rule. If you feel the need to say "note
that", consider what adjacent material you shouldn't be saying at all.
* Say "symbolic link" instead of "symlink".
* When one sentence explains the previous, use a semicolon.
* Place the modifier "only" more carefully.
* Recast option descriptions to be in the imperative mood.
* Recast file descriptions to use the paragraph tag as the subject of
the first sentence.
Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
Diffstat (limited to 'man3/stdio_ext.3')
0 files changed, 0 insertions, 0 deletions
