Skip to content

Commit

Permalink
doc: nits
Browse files Browse the repository at this point in the history
  • Loading branch information
Ken Kundert authored and Ken Kundert committed Jun 8, 2024
1 parent f0718d6 commit 3b63e2d
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ simply and cleanly print different types of messages. For example:
.. code-block:: python
>>> from inform import display, error, os_error
>>> display('This is a plain message.')
This is a plain message.
Expand Down Expand Up @@ -72,7 +73,7 @@ Installation

Install the latest stable version with::

pip3 install --user inform
pip3 install inform

Requires Python2.7 or Python3.3 or better.

Expand Down Expand Up @@ -201,12 +202,13 @@ Besides the four informants already described, *Inform* provides several others,
including :ref:`log informant`, :ref:`codicil informant`, :ref:`comment
informant`, :ref:`narrate informant`, :ref:`output informant`, :ref:`notify
informant`, :ref:`debug informant` and :ref:`panic informant`. Informants in
general can write to the log file, to the standard output, or to a notifier.
They can add headers and specify the color of the header and the message. They
can also continue the previous message or they can terminate the program. Each
informant embodies a predefined set of these choices. In addition, they are
affected by options passed to the active informer (described next), which is
often used to enable or disable informants based on various verbosity options.
general can write to the log file, to the standard output or standard error, or
to a notifier. They can add headers and specify the color of the header and the
message. They can also continue the previous message or they can terminate the
program. Each informant embodies a predefined set of these choices. In
addition, they are affected by options passed to the active informer (described
next), which is often used to enable or disable informants based on various
verbosity options.


Controlling Informants
Expand Down Expand Up @@ -310,7 +312,7 @@ constructing messages.
- Generates clean messages for operating system errors

* - :ref:`parse_range desc`
- Converts a set of numbers from a succinct, readable string that
- Converts a set of numbers from a succinct, readable string that
summarizes the set.

* - :ref:`plural desc`
Expand Down

0 comments on commit 3b63e2d

Please sign in to comment.