From 2396224c5cda95e687325dcbc4ee41eb84511611 Mon Sep 17 00:00:00 2001 From: Bryan Lai Date: Tue, 17 Dec 2024 14:07:23 +0800 Subject: [PATCH] release: bugfix v2.0.1 & warn about lib instability --- Cargo.lock | 2 +- Cargo.toml | 2 +- src/lib.rs | 9 +++++++++ 3 files changed, 11 insertions(+), 2 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 555e92c..2005679 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -785,7 +785,7 @@ checksum = "7d71d3574edd2771538b901e6549113b4006ece66150fb69c0fb6d9a2adae946" [[package]] name = "hydra-check" -version = "2.0.0" +version = "2.0.1" dependencies = [ "anyhow", "clap", diff --git a/Cargo.toml b/Cargo.toml index a4bbdce..e1efa69 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "hydra-check" -version = "2.0.0" +version = "2.0.1" authors = ["Felix Richter ", "Bryan Lai "] edition = "2021" diff --git a/src/lib.rs b/src/lib.rs index 0e261b5..fd0fcd7 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,4 +1,13 @@ #![warn(missing_docs)] + +//!
+//! +//! Currently hydra-check is only provided as a CLI application, _not_ as a library. +//! We exposed the library documentation here for internal reference. +//! We do _not_ provide any guarantee about the stability of these interfaces. +//! +//!
+//! #![doc = include_str!("../README.md")] mod args;