diff --git a/README.rst b/README.rst index efc1cc3..f77ac1a 100644 --- a/README.rst +++ b/README.rst @@ -24,8 +24,8 @@ Eliot supports a range of use cases and 3rd party libraries: * Logging within a single process. * Causal tracing across a distributed system. -* Scientific computing, with `built-in support for NumPy and Dask `_. -* `Asyncio coroutines `_ and the `Twisted networking framework `_. +* Scientific computing, with `built-in support for NumPy and Dask `_. +* `Asyncio and Trio coroutines `_ and the `Twisted networking framework `_. Eliot is only used to generate your logs; you will might need tools like Logstash and ElasticSearch to aggregate and store logs if you are using multiple processes across multiple machines. diff --git a/docs/source/index.rst b/docs/source/index.rst index e5a2cb9..deef6b9 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -21,7 +21,7 @@ Eliot supports a range of use cases and 3rd party libraries: * Logging within a single process. * Causal tracing across a distributed system. * Scientific computing, with :doc:`built-in support for NumPy and Dask `. -* :doc:`Asyncio coroutines ` and the :doc:`Twisted networking framework `. +* :doc:`Asyncio and Trio coroutines ` and the :doc:`Twisted networking framework `. Eliot is only used to generate your logs; you might still need tools like Logstash and ElasticSearch to aggregate and store logs if you are using multiple processes across multiple machines. diff --git a/docs/source/outputting/output.rst b/docs/source/outputting/output.rst index 28b5346..dd57107 100644 --- a/docs/source/outputting/output.rst +++ b/docs/source/outputting/output.rst @@ -21,7 +21,7 @@ This ensures that no messages will be lost if logging happens during configurati Outputting JSON to a file --------------------- +------------------------- Since JSON is a common output format, Eliot provides a utility class that logs to a file, ``eliot.FileDestination(file=yourfile)``. Each Eliot message will be encoded in JSON and written on a new line. diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst index d7d9a88..6b81f2b 100644 --- a/docs/source/quickstart.rst +++ b/docs/source/quickstart.rst @@ -127,4 +127,5 @@ You can learn more by reading the rest of the documentation, including: * How to generate :doc:`actions `, :doc:`standalone messages `, and :doc:`handle errors `. * How to integrate or migrate your :doc:`existing stdlib logging messages `. * How to output logs :doc:`to a file or elsewhere `. -* Using :doc:`asyncio coroutines `, :doc:`threads and processes `, or :doc:`Twisted `. +* Using :doc:`asyncio or Trio coroutines `, :doc:`threads and processes `, or :doc:`Twisted `. +* Using Eliot for :doc:`scientific computing `.