svn commit: r42058 - head/en_US.ISO8859-1/books/fdp-primer/writing-style
Warren Block
wblock at FreeBSD.org
Wed Jun 26 04:23:11 UTC 2013
Author: wblock
Date: Wed Jun 26 04:23:10 2013
New Revision: 42058
URL: http://svnweb.freebsd.org/changeset/doc/42058
Log:
Point out that examples must be tested.
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 02:25:45 2013 (r42057)
+++ head/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml Wed Jun 26 04:23:10 2013 (r42058)
@@ -71,8 +71,8 @@
rather than <quote>you can copy the file to
<filename>/tmp</filename></quote>.</para>
- <para>Give clear, correct examples. A trivial example is better
- than no example, but a good example is better yet. Do not
+ <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,
More information about the svn-doc-head
mailing list