Corrected docstrings in coffeedoc.coffee

lmaccherone · Jul 28, 2011 · 44cb8ae · 44cb8ae
1 parent 8fd246a
commit 44cb8ae
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 14 deletions.
diff --git a/lib/coffeedoc.js b/lib/coffeedoc.js
diff --git a/src/coffeedoc.coffee b/src/coffeedoc.coffee
@@ -1,8 +1,8 @@
 ###
 Documentation functions
 =======================
-These functions extract relevant documentation info from AST nodes as
-returned by the coffeescript parser.
+These functions extract relevant documentation info from AST nodes as returned
+by the coffeescript parser.
 ###
 
 coffeescript = require('coffee-script')
@@ -44,16 +44,15 @@ getNodes = (script) ->
 
 getClasses = (nodes) ->
     ###
-    Returns all top-level class nodes from the AST as returned by
-    getNodeTypes
+    Returns all top-level class nodes from the AST as returned by getNodes
     ###
     return (n for n in nodes when n.type == 'Class' \
             or n.type == 'Assign' and n.value.type == 'Class')
 
 getFunctions = (nodes) ->
     ###
     Returns all top-level named function nodes from the AST as returned by
-    getNodeTypes
+    getNodes
     ###
     return (n for n in nodes \
             when n.type == 'Assign' and n.value.type == 'Code')
@@ -70,8 +69,8 @@ getNodeName = (node) ->
 
 documentClass = (cls) ->
     ###
-    Evaluates a class object as returned by the coffeescript parser,
-    returning an object of the form:
+    Evaluates a class object as returned by the coffeescript parser, returning
+    an object of the form:
     
         {
             "name": "MyClass",