confusing sentence in hardware notes boilerplate
Joe Altman
freebsd at chthonixia.net
Tue Dec 25 00:20:44 UTC 2012
On Mon, Dec 24, 2012 at 10:08:11PM +0000, Benjamin Kaduk wrote:
> I was going over the various release notes documents to do some editing,
> and spent entirely too much time trying to understand a sentence at the
> top of the hardware notes, which has been there since r172098 by bmah in
> 2007. I think that adding a word per below helps the readability, but I
> am no longer an impartial reader (having read the sentence too much).
> Thoughts?
I try to refrain from using the same word more than once, when they are
in proximity. To me, adding "supported" as you propose is such.
Additionally, the phrase "...known working instances..." seems to
re-state the word "supported".
OTOH, it could be written:
This document lists the supported hardware platforms and devices such as
storage controllers, network interfaces, and so on, for &os;
&release.current;.
ISTM that "...hardware compatibility...", "...hardware platforms
supported..." and "...known working instances..." are different ways of
saying one thing. So just say it once at the beginning of the sentence.
> -Ben
>
> Index: article.xml
> ===================================================================
> --- article.xml (revision 244663)
> +++ article.xml (working copy)
> @@ -53,7 +53,7 @@
g> <para>This document contains the hardware compatibility notes for
> &os; &release.current;. It lists the hardware platforms
> supported by &os;, as well as the various types of hardware
> - devices (storage controllers, network interfaces, and so on),
> + devices supported (storage controllers, network interfaces, and so on),
> along with known working instances of these devices.</para>
> </sect1>
More information about the freebsd-doc
mailing list