[Checkins]
SVN: Sandbox/philikon/foundation/maintaining-software.txt
Clarify and fix English
Philipp von Weitershausen
philikon at philikon.de
Fri Aug 24 07:00:14 EDT 2007
Log message for revision 79217:
Clarify and fix English
Changed:
U Sandbox/philikon/foundation/maintaining-software.txt
-=-
Modified: Sandbox/philikon/foundation/maintaining-software.txt
===================================================================
--- Sandbox/philikon/foundation/maintaining-software.txt 2007-08-24 10:51:35 UTC (rev 79216)
+++ Sandbox/philikon/foundation/maintaining-software.txt 2007-08-24 11:00:14 UTC (rev 79217)
@@ -194,9 +194,10 @@
or a full-fledged manual for the piece of software. It may also
contain a changelog.
- It is also acceptable to refer to a README.txt inside the actual
- Python package. This is sometimes necessary when the README.txt
- is used as a doctest at the same time.
+ If ``README.txt`` contains a doctest that should be run as part of
+ the automated test suite, it usually needs to be placed inside the
+ Python package. In this case, a small ``README.txt`` at the top
+ level should point readers to it.
If the package has an associated mailinglist and a bugtracker, it
is a good idea to mention it here.
@@ -267,7 +268,7 @@
* ``description`` should be a one-sentence description of the
package while ``long_description`` is best taken from the
- ``README.txt`` file a demonstrated. If the changelog is in a
+ ``README.txt`` file as demonstrated. If the changelog is in a
separate ``CHANGES.txt``, you may concatenate the two to form
``long_description``.
More information about the Checkins
mailing list