Browse files

[QA] Grammar and line wrapping fixes in docs.

  • Loading branch information...
1 parent 3ccd7a4 commit ee9daeb278004c42021663beff09136baff37ae9 @JNRowe committed Oct 25, 2012
Showing with 14 additions and 17 deletions.
  1. +2 −5 NEWS.rst
  2. +12 −12 README.rst
View
7 NEWS.rst
@@ -9,7 +9,7 @@ User-visible changes
0.6.0 - 2011-05-13
------------------
-* Massive clean up, this is just a mainenance release
+* Massive clean up, this is just a maintenance release
* Switched to Sphinx_ for documentation
.. _Sphinx: http://sphinx.pocoo.org/
@@ -30,11 +30,8 @@ User-visible changes
* Fixed installs with easy_install
* SBNs can now be represented with the ``SBN`` object
-* Python "egg" packages can now be built if setuptools_ is installed
-* This package has been renamed ``pyisbn`` from ``ISBN`` to be more compliant
- with PEP-8_'s naming guidelines
+* Python "egg" packages can now be built, if setuptools_ is installed
-.. _PEP-8: http://www.python.org/dev/peps/pep-0008/
.. _setuptools: http://peak.telecommunity.com/DevCenter/setuptools
0.3.0 - 2007-12-11
View
24 README.rst
@@ -1,12 +1,9 @@
-``pyisbn``
-==========
+``pyisbn`` - A module for working with 10- and 13-digit ISBNs
+=============================================================
.. image:: https://secure.travis-ci.org/JNRowe/pyisbn.png?branch=master
:target: http://travis-ci.org/JNRowe/pyisbn
-A module for working with 10- and 13-digit ISBNs
-------------------------------------------------
-
Introduction
------------
@@ -29,14 +26,13 @@ installed, open an issue_ and I'll endeavour to fix it.
The module have been tested on many UNIX-like systems, including Linux and OS X,
but it should work fine on other systems too.
-.. [#] The module may work with older Python versions, but it has only
- been tested with v2.4 and above.
+.. [#] The module may work with older Python versions, but it has only been
+ tested with v2.4 and above.
Example
-------
-The simplest way to show how ``pyisbn`` works is by example, and here
-goes::
+The simplest way to show how ``pyisbn`` works is by example, and here goes::
>>> import pyisbn
>>> Permutation_City = "1-85798-218-5"
@@ -72,10 +68,14 @@ aren't backwards compatible will force a major version bump.
Bugs
----
-If you find a bug don't hesitate to open an issue, preferably including
-a minimal testcase or even better a patch!
+If you find any problems, bugs or just have a question about this package either
+file an issue_ or drop me a mail_.
+
+If you've found a bug please attempt to include a minimal testcase so I can
+reproduce the problem, or even better a patch!
.. _GPL v3: http://www.gnu.org/licenses/
-.. _view the content online: http://packages.python.org/pyisbn
+.. _view the content online: http://pyisbn.rtfd.org/
.. _Python: http://www.python.org/
.. _issue: http://github.com/JNRowe/pyisbn/issues
+.. _mail: jnrowe@gmail.com

0 comments on commit ee9daeb

Please sign in to comment.