Permalink
Browse files

Fix the documentation.

  • Loading branch information...
1 parent ab80b86 commit cf0c9a166f549d75bdb081728cb70e7c0a9d18e9 @kijun kijun committed with Lee Heung-sub Oct 5, 2010
Showing with 11 additions and 12 deletions.
  1. +5 −5 README
  2. +6 −7 docs/index.rst
View
10 README
@@ -1,13 +1,13 @@
jDoctest
~~~~~~~~
-jDoctest is an useful test library for JavaScript that inspired by
+jDoctest is an useful test library for JavaScript that was inspired by
`Python`_'s `doctest`_ module. It finds testable examples within your
-JavaScript files and checks if each examples runs successfully.
+JavaScript files and checks if each example runs successfully.
-No more you need separated test files or documentation files. You need *a
-single file* which contains an executable source code, documentations, testable
-examples.
+No more you need separated test files or documentation files. You only need *a
+single file* which contains an executable source code, documentations, and
+testable examples.
.. _Python: http://python.org/
.. _doctest: http://docs.python.org/library/doctest.html
View
@@ -15,7 +15,7 @@ jDoctest supports these common browsers.
- Firefox
- Opera
-jDoctest doesn't support Internet Explorer yetm because IE's implementation of
+jDoctest doesn't support Internet Explorer yet, because IE's implementation of
the ``eval`` function is different from other supported browsers.
Getting jDoctest
@@ -40,8 +40,7 @@ How To Use
Simple Tutorial
---------------
-Here is a small sample code. jDoctest suggests to you're JavaScript source code
-to follow this structure:
+Here is a small sample code:
.. sourcecode:: js
@@ -61,8 +60,8 @@ to follow this structure:
/**:ImageFile.prototype.fetchData()
Requests the server for the image file. When the request is
- complete, it also sets the ``size`` and ``modified`` attributes of
- the object.
+ complete, it also sets the ``size`` and ``modified`` attributes
+ of the object.
>>> img.fetchData();
>>> wait(function() { return img.data; });
@@ -222,7 +221,7 @@ can now test using jDoctest-QUnit instead of vanilla jDoctest.
.. _QUnit: http://docs.jquery.com/qunit
-How it works
+How It Works
============
jDoctest examines docstrings in your source code to find testable examples.
@@ -294,7 +293,7 @@ a result of :func:`jDoctest.repr`. If the expected value is ``undefined``, the
output section is not needed. jDoctest will check if the expected output equals
the actual output and report the result.
-Testing with a Blank Line
+Using ``BLANKLINE`` Token
-------------------------
A testable example doesn't contain a blank line, but what if your expected

0 comments on commit cf0c9a1

Please sign in to comment.