diff options
author | Clement Tsang <34804052+ClementTsang@users.noreply.github.com> | 2022-06-14 18:31:32 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-06-14 18:31:32 -0400 |
commit | c6f5d5488a12bceff9210e3e00d168cd122aa281 (patch) | |
tree | 91c56799953e48e581308d03ddd8a1f4c2da6f9b | |
parent | 122373aff7069844c0f5a2cfaa4d7b9661fb4693 (diff) |
docs: re-enable lib docs for development purposes (#750)
Enables lib docs, primarily intended for dev use. Also change some existing documentation based on warnings (mainly broken/bare links).
-rw-r--r-- | Cargo.toml | 4 | ||||
-rw-r--r-- | src/app/data_harvester/batteries/battery.rs | 2 | ||||
-rw-r--r-- | src/canvas.rs | 2 | ||||
-rw-r--r-- | src/lib.rs | 10 |
4 files changed, 13 insertions, 5 deletions
@@ -20,8 +20,8 @@ doc = false [lib] test = true -doctest = false -doc = false +doctest = true +doc = true [profile.release] debug = 0 diff --git a/src/app/data_harvester/batteries/battery.rs b/src/app/data_harvester/batteries/battery.rs index 85ef3b48..0b3da61e 100644 --- a/src/app/data_harvester/batteries/battery.rs +++ b/src/app/data_harvester/batteries/battery.rs @@ -7,7 +7,7 @@ //! - FreeBSD //! - DragonFlyBSD //! -//! For more information, see https://github.com/starship/rust-battery +//! For more information, refer to the [starship_battery](https://github.com/starship/rust-battery) repo/docs. use starship_battery::{ units::{power::watt, ratio::percent, time::second}, diff --git a/src/canvas.rs b/src/canvas.rs index 7bfcf284..f5ee4488 100644 --- a/src/canvas.rs +++ b/src/canvas.rs @@ -59,7 +59,7 @@ impl FromStr for ColourScheme { } } -/// Handles the canvas' state. TODO: [OPT] implement this. +/// Handles the canvas' state. pub struct Painter { pub colours: CanvasColours, height: u16, @@ -1,3 +1,10 @@ +//! A customizable cross-platform graphical process/system monitor for the terminal. +//! Supports Linux, macOS, and Windows. Inspired by gtop, gotop, and htop. +//! +//! **Note:** The following documentation is primarily intended for people to refer to for development purposes rather +//! than the actual usage of the application. If you are instead looking for documentation regarding the *usage* of +//! bottom, refer to [here](https://clementtsang.github.io/bottom/stable/). + #![warn(rust_2018_idioms)] #[allow(unused_imports)] #[cfg(feature = "log")] @@ -273,7 +280,8 @@ pub fn cleanup_terminal( Ok(()) } -/// Based on https://github.com/Rigellute/spotify-tui/blob/master/src/main.rs +/// A panic hook to properly restore the terminal in the case of a panic. +/// Based on [spotify-tui's implementation](https://github.com/Rigellute/spotify-tui/blob/master/src/main.rs). pub fn panic_hook(panic_info: &PanicInfo<'_>) { let mut stdout = stdout(); |