typos and docu

This commit is contained in:
Christoph J. Scherr 2023-07-08 15:42:28 +02:00
parent a25bf40a5b
commit e50c4dfe05
Signed by: PlexSheep
GPG Key ID: 25B4ACF7D88186CC
3 changed files with 8 additions and 9 deletions

View File

@ -1,4 +1,4 @@
//! # args module
//!
//! The args module of pt is used to parse commandline arguments. Fot this, it makes use of
//! The args module of pt is used to parse commandline arguments. For this, it makes use of
//! [`clap`].

View File

@ -30,8 +30,7 @@ pub use crate::get_stdout_for;
///
/// This is especially useful when testing loggers or other frontend CLI functions.
///
/// Inspiration: [users.rust-lang.org](https://users.rust-lang.org/t/how-to-test-functions-that-use-
/// println/67188/5)
/// Inspiration: [users.rust-lang.org](https://users.rust-lang.org/t/how-to-test-functions-that-use-println/67188/5)
#[macro_export]
macro_rules! get_stdout_for {
($test:expr) => {{

View File

@ -1,14 +1,14 @@
//! # A specialized Logger for [`libpt`](crate)
//!
//! For the library version, only the basic [`log`](crate::log) is used, so that it is possible for
//! the end user to use the [`log`](crate::log) frontend they desire.
//! For the library version, only the basic [`log`] is used, so that it is possible for
//! the end user to use the [`log`] frontend they desire.
//!
//! I did however decide to create a [`Logger`] struct. This struct is mainly intended to be used
//! with the python module of [`libpt`], but is still just as usable in other contexts.
//! with the python module of [`libpt`](crate), but is still just as usable in other contexts.
//!
//! ## Technologies used for logging:
//! - [`log`](crate::log): base logging crate
//! - [`env_logger`](crate::env_logger): used for the executable
//! - [`log`]: base logging crate
//! - [`env_logger`]: used for the executable
//// ATTRIBUTES ////////////////////////////////////////////////////////////////////////////////////
@ -32,7 +32,7 @@ pub const LOGGER_ENV_KEY: &'static str = "LIBPT_LOGLEVEL";
static INITIALIZED: AtomicBool = AtomicBool::new(false);
//// STRUCTS ///////////////////////////////////////////////////////////////////////////////////////
/// ## Logger for [`libpt`](crate::libpt)
/// ## Logger for [`libpt`](crate)
///
/// This struct exists mainly for the python module, so that we can use the same logger with both
/// python and rust.