From 88dfc0d6645f88dcc0d16ecbef866894290fa785 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fe=CC=81lix=20Saparelli?= Date: Sun, 17 Oct 2021 01:16:41 +1300 Subject: [PATCH] Add note about logging and error handling to main lib doc --- lib/src/lib.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/lib/src/lib.rs b/lib/src/lib.rs index 0a674db..a0af184 100644 --- a/lib/src/lib.rs +++ b/lib/src/lib.rs @@ -84,6 +84,11 @@ //! at the cost of reimplementing the glue code. See the examples folder for some basic/demo tools //! written with the individual modules. //! +//! Note that the library generates a _lot_ of debug messaging with [tracing]. You should not enable +//! printing even error log messages for this crate unless it's for debugging. Instead, make use of +//! the [`InitConfig::on_error()`][config::InitConfig::on_error()] method to define a handler for +//! errors occurring at runtime that are _meant_ for you to handle (by printing out or otherwise). +//! //! This crate does not itself use `unsafe`. However, it depends on a number of libraries which do, //! most because they interact with the operating system.