diff --git a/docs/README.md b/docs/README.md index 111eaa3b0..95cdecd1a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,6 +8,7 @@ along with associated configuration and helper files, including the Lissp syntax highlighter. A significant additional portion of Hissp's rendered documentation is derived from docstrings in Hissp's source code (the API docs). + ## Quick Links ${\boldsymbol {\color{royalblue}{(}\color{green}{\textsf -}\color{gold}{)}\color{gainsboro}{\kern-1.5pt{\textsf :}}}}$ [Rendered Documentation ](https://hissp.readthedocs.io/) 🢦 START HERE. diff --git a/docs/lissp_whirlwind_tour.rst b/docs/lissp_whirlwind_tour.rst index d5946f0e4..27af98c1a 100644 --- a/docs/lissp_whirlwind_tour.rst +++ b/docs/lissp_whirlwind_tour.rst @@ -1050,7 +1050,7 @@ Lissp Whirlwind Tour ;;; on local variables, which can't be imported. For these, we use a $# ;;; (gensym) which (instead of a qualifier) adds a prefix to ensure a ;;; variable can only be used in the same template it was defined in. It - ;;; contains a hash of the following, the code being read, __name__, and + ;;; contains a hash of three things: the code being read, __name__, and ;;; a count of the templates the reader has seen so far. #> `($#eggs $#spam $#bacon $#spam) diff --git a/src/hissp/macros.lissp b/src/hissp/macros.lissp index 29b497b21..0997f96a5 100644 --- a/src/hissp/macros.lissp +++ b/src/hissp/macros.lissp @@ -692,7 +692,7 @@ Hidden doctest adds bundled macros for REPL-consistent behavior. (defmacro X\# e <<# - ;; ``X#`` Anaphoric. Make ``e`` an anonymous function with paramter X. + ;; ``X#`` Anaphoric. Make ``e`` an anonymous function with parameter X. ;; ;; Examples: ;; @@ -764,7 +764,7 @@ Hidden doctest adds bundled macros for REPL-consistent behavior. `(lambda ,'X ,e)) (defmacro XY\# e - "``XY#`` Anaphoric. Make ``e`` an anonymous function with paramters X Y. + "``XY#`` Anaphoric. Make ``e`` an anonymous function with parameters X Y. .. code-block:: REPL @@ -783,7 +783,7 @@ Hidden doctest adds bundled macros for REPL-consistent behavior. (defmacro XYZ\# e <<# - ;; ``XYZ#`` Anaphoric. Make ``e`` an anonymous function with paramters X Y Z. + ;; ``XYZ#`` Anaphoric. Make ``e`` an anonymous function with parameters X Y Z. ;; ;; .. code-block:: REPL ;; @@ -801,7 +801,7 @@ Hidden doctest adds bundled macros for REPL-consistent behavior. (defmacro XYZW\# e <<# - ;; ``XYZW#`` Anaphoric. Make ``e`` an anonymous function with paramters X Y Z W. + ;; ``XYZW#`` Anaphoric. Make ``e`` an anonymous function with parameters X Y Z W. ;; ;; .. code-block:: REPL ;; @@ -1870,7 +1870,7 @@ Hidden doctest adds bundled macros for REPL-consistent behavior. <<# ;; ``@`` 'list of' Mnemonic: @rray list. ;; - ;; Creates the `list` from each expresssion's result. + ;; Creates the `list` from each expression's result. ;; A ``:*`` unpacks the next argument. ;; ;; .. code-block:: REPL @@ -2029,7 +2029,7 @@ Hidden doctest adds bundled macros for REPL-consistent behavior. ;; return k ;; ;; ``Ensue`` takes a step function and returns a generator. The step - ;; function recieves the previous Ensue step and must return the next + ;; function receives the previous Ensue step and must return the next ;; one to continue. Returning a different type raises a `StopIteration` ;; with that object. Set the ``Y`` attribute on the current step to ;; [Y]ield a value this step. Set the ``F`` attribute to a true value @@ -2342,10 +2342,10 @@ Hidden doctest adds bundled macros for REPL-consistent behavior. ;; >>> echo.send( ;; ... None) ;; - ;; #> (.send echo "Yodle!") ; Generators are two-way. + ;; #> (.send echo "Yodel!") ; Generators are two-way. ;; >>> echo.send( - ;; ... ('Yodle!')) - ;; 'Yodle!' + ;; ... ('Yodel!')) + ;; 'Yodel!' ;; ;; #> (.send echo 42) ;; >>> echo.send(