TANAL-135: Docstring clarification + fixed typos + fixed 1 indentation

Author: green-coder

README.md

@@ -148,7 +148,7 @@ clojure.tools.analyzer.jvm> (ast/update-children (analyze '(do 1 (+ 1 2) :foo))
   ...},
  ...}
 ```
-If it's desiderable to walk all the AST applying a function to all the nodes and the children nodes, one of `walk`, `prewalk` or `postwalk` should be used, read the docstrings of the three functions to understand the differences.
+If it's desirable to walk all the AST applying a function to all the nodes and the children nodes, one of `walk`, `prewalk` or `postwalk` should be used, read the docstrings of the three functions to understand the differences.
 Here's the previous example using `prewalk` instead of `update-children`:
 ```clojure
 clojure.tools.analyzer.jvm> (ast/prewalk (analyze '(do 1 (+ 1 2) :foo))

src/main/clojure/clojure/tools/analyzer.clj

@@ -102,7 +102,7 @@
    * :form the form represented by the AST node
    * :env  the environment map of the AST node
 
-   Additionaly if the AST node contains sub-nodes, it is guaranteed to have:
+   Additionally if the AST node contains sub-nodes, it is guaranteed to have:
    * :children a vector of the keys of the AST node mapping to the sub-nodes,
                ordered, when that makes sense
 

src/main/clojure/clojure/tools/analyzer/ast.clj

@@ -12,7 +12,7 @@
   (:require [clojure.tools.analyzer.utils :refer [into! rseqv mapv']]))
 
 (defn cycling
-  "Combine the given passes in a single pass that will be applieed repeatedly
+  "Combine the given passes in a single pass that will be applied repeatedly
    to the AST until applying it another time will have no effect"
   [& fns*]
   (let [fns (cycle fns*)]
@@ -26,7 +26,7 @@
 (defn children*
   "Return a vector of vectors of the children node key and the children expression
    of the AST node, if it has any.
-   The returned vector returns the childrens in the order as they appear in the
+   The returned vector returns the children in the order as they appear in the
    :children field of the AST, and the children expressions may be either a node
    or a vector of nodes."
   [{:keys [children] :as ast}]

src/main/clojure/clojure/tools/analyzer/ast/query.clj

@@ -29,7 +29,7 @@
   "Given a Datomic query, walk the :where clauses searching for
    expression clauses with nested calls, unnesting those calls.
 
-   E.g {:where [[(inc (dec ?foo)) ?bar] ..] ..} will be transformed in
+   E.g {:where [[(inc (dec ?foo)) ?bar] ..] ..} will be transformed into
    {:where [[(dec ?foo) ?1234] [(inc ?1234) ?bar] ..] ..}"
   [query]
   (let [{:keys [where] :as query} (query-map query)]

src/main/clojure/clojure/tools/analyzer/env.clj

@@ -10,9 +10,9 @@
   (:refer-clojure :exclude [ensure]))
 
 (def ^:dynamic *env*
-  "Global env atom
+  "Global env atom containing a map.
    Required options:
-    * :namespaces an atom containing a map from namespace symbol to namespace map,
+    * :namespaces a map from namespace symbol to namespace map,
       the namespace map contains at least the following keys:
      ** :mappings a map of mappings of the namespace, symbol to var/class
      ** :aliases a map of the aliases of the namespace, symbol to symbol

src/main/clojure/clojure/tools/analyzer/passes.clj

@@ -65,7 +65,7 @@
    * the remaining scheduler state
 
    E.g. given:
-   [{:walk :any .. } {:walk :pre ..} {:walk :post ..} {:walk :pre ..}]
+   [{:walk :any ..} {:walk :pre ..} {:walk :post ..} {:walk :pre ..}]
    it will return:
    [:pre [{:walk :any ..} {:walk :pre ..}] [{:walk :post ..} {:walk :pre ..}]]"
   [state]

src/test/clojure/clojure/tools/analyzer/core_test.clj

@@ -15,7 +15,7 @@
        (= (first opname) \.) ; (.foo bar ..)
        (let [[target & args] expr
              args (list* (symbol (subs opname 1)) args)]
-         (with-meta (list '. target (if (= 1 (count args)) ;; we don't know if (.foo bar) ia
+         (with-meta (list '. target (if (= 1 (count args)) ;; we don't know if (.foo bar) is
                                       (first args) args)) ;; a method call or a field access
            (meta form)))
 
@@ -36,7 +36,7 @@
                    (:macro (meta v)))
             (apply v form env (rest form)) ; (m &form &env & args)
             (desugar-host-expr form)))))
-        form))
+    form))
 
 (defmacro foo [] 1)