Skip to content

Commit 0d15dff

Browse files
authored
Minor documentation fixes (#907)
1 parent cc3b33b commit 0d15dff

File tree

4 files changed

+8
-7
lines changed

4 files changed

+8
-7
lines changed

docs/compiler.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Since the compiler cannot reason about larger units of code, it cannot make infe
1313

1414
There are three steps to the Basilisp compiler: analysis, generation, and optimization.
1515
After a Basilisp form is read in by the :ref:`reader`, it is passed off to the analyzer to produce an abstract syntax tree.
16-
The generator reads the AST and produces Python code (_not_ bytecode) using Python's builtin `ast <https://docs.python.org/3/library/ast.html>`_ module.
16+
The generator reads the AST and produces Python code (*not* bytecode) using Python's builtin `ast <https://docs.python.org/3/library/ast.html>`_ module.
1717
Afterwards, the compiler passes the generated AST through a quick optimization phase to remove redundant branches and other artifacts of code generation.
1818
From there, the compiler injects the compiled code into a dynamically-generated Python module which is associated with a Basilisp Namespace and executes the code so the generated objects are available.
1919

docs/contributing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ To prepare your `poetry` environment, you need to install dependencies:
6060
poetry install
6161
6262
Afterwards, you can open a new Poetry shell to start up the REPL for development.
63-
The ``make repl`` target _may_ be sufficient for local development, though developers working on the Basilisp compiler or standard library are encouraged to enable a more verbose set of configurations for detecting issues during development.
63+
The ``make repl`` target *may* be sufficient for local development, though developers working on the Basilisp compiler or standard library are encouraged to enable a more verbose set of configurations for detecting issues during development.
6464
The command below enables the highest level of logging and disables namespace caching, both of which can help reveal otherwise hidden issues during development.
6565

6666
.. code-block:: bash

docs/reader.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ nil
233233
basilisp.user=> (python/type nil)
234234
<class 'NoneType'>
235235

236-
The special value ``nil`` correspond's to Python's ``None``.
236+
The special value ``nil`` corresponds to Python's ``None``.
237237

238238
.. _whitespace:
239239

@@ -327,7 +327,7 @@ Maps
327327
{1 "2" :three 3}
328328

329329
Maps are denoted with the ``{}`` characters.
330-
Sets may contain 0 or more heterogenous key-value pairs.
330+
Maps may contain 0 or more heterogenous key-value pairs.
331331
Basilisp maps are modeled after Clojure's persistent map implementation.
332332

333333
.. _sets:
@@ -354,7 +354,7 @@ Line Comments
354354
Line comments are specified with the ``;`` character.
355355
All of the text to the end of the line are ignored.
356356

357-
For a convenience in writing shell scripts with Basilisp, the standard \*NIX `shebang <https://en.wikipedia.org/wiki/Shebang_(Unix)>` (``#!``) is also treated as a single-line comment.
357+
For a convenience in writing shell scripts with Basilisp, the standard \*NIX `shebang <https://en.wikipedia.org/wiki/Shebang_(Unix)>`_ (``#!``) is also treated as a single-line comment.
358358

359359
.. _metadata:
360360

@@ -390,7 +390,7 @@ Reader macros are always dispatched using the ``#`` character.
390390

391391
* ``#'form`` is rewritten as ``(var form)``.
392392
* ``#_form`` causes the reader to completely ignore ``form``.
393-
* ``#!form`` is treated as a single-line comment (like ``;form``) as a convenience to support `shebangs <https://en.wikipedia.org/wiki/Shebang_(Unix)>` at the top of Basilisp scripts.
393+
* ``#!form`` is treated as a single-line comment (like ``;form``) as a convenience to support `shebangs <https://en.wikipedia.org/wiki/Shebang_(Unix)>`_ at the top of Basilisp scripts.
394394
* ``#"str"`` causes the reader to interpret ``"str"`` as a regex and return a Python `re.pattern <https://docs.python.org/3/library/re.html>`_.
395395
* ``#(...)`` causes the reader to interpret the contents of the list as an anonymous function. Anonymous functions specified in this way can name arguments using ``%1``, ``%2``, etc. and rest args as ``%&``. For anonymous functions with only one argument, ``%`` can be used in place of ``%1``.
396396

docs/specialforms.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,8 @@ Primary Special Forms
370370
The Basilisp compiler makes attempts to verify whether a ``set!`` is legal at compile time, but there are cases which must be deferred to runtime due to the dynamic nature of the language.
371371
In particular, due to the non-lexical nature of dynamic Var bindings, it can be difficult to establish if a Var is thread-bound when it is ``set!``, so this check is deferred to runtime.
372372

373-
.. lpy:specialform:: (throw exc cause?)
373+
.. lpy:specialform:: (throw exc)
374+
(throw exc cause)
374375
375376
Throw the exception named by ``exc``.
376377
The semantics of ``throw`` are identical to those of Python's `raise <https://docs.python.org/3/reference/simple_stmts.html#the-raise-statement>`_ statement with exception.

0 commit comments

Comments
 (0)