Date: Wed, 26 Jun 2013 04:23:10 +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: r42058 - head/en_US.ISO8859-1/books/fdp-primer/writing-style Message-ID: <201306260423.r5Q4NAmt081320@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
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,
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201306260423.r5Q4NAmt081320>