Date: Wed, 26 Jun 2013 04:24:45 +0000 (UTC) From: Warren Block <wblock@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r42059 - head/en_US.ISO8859-1/books/fdp-primer/writing-style Message-ID: <201306260424.r5Q4Oja6081497@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: wblock Date: Wed Jun 26 04:24:45 2013 New Revision: 42059 URL: http://svnweb.freebsd.org/changeset/doc/42059 Log: Whitespace-only changes. Translators, please ignore. Modified: head/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml Modified: head/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml Wed Jun 26 04:23:10 2013 (r42058) +++ head/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml Wed Jun 26 04:24:45 2013 (r42059) @@ -71,14 +71,14 @@ rather than <quote>you can copy the file to <filename>/tmp</filename></quote>.</para> - <para>Give clear, correct, <emphasis>tested</emphasis> examples. A trivial example is better - than no example. A good example is better yet. Do not - give bad examples, identifiable by apologies or sentences like - <quote>but really it should never be done that way</quote>. - Bad examples are worse than no examples. Give good examples, - because <emphasis>even when warned not to use the example - as shown</emphasis>, the reader will usually just use the - example as shown.</para> + <para>Give clear, correct, <emphasis>tested</emphasis> examples. + A trivial example is better than no example. A good example + is better yet. Do not give bad examples, identifiable by + apologies or sentences like <quote>but really it should never + be done that way</quote>. Bad examples are worse than no + examples. Give good examples, because <emphasis>even when + warned not to use the example as shown</emphasis>, the + reader will usually just use the example as shown.</para> <para>Avoid <emphasis>weasel words</emphasis> like <quote>should</quote>, <quote>might</quote>,
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201306260424.r5Q4Oja6081497>