doc

kingwingfly · Feb 14, 2024 · 8200be5 · 8200be5
1 parent 46b8ff1
commit 8200be5
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 4 deletions.
diff --git a/fav_cli/src/lib.rs b/fav_cli/src/lib.rs
@@ -1,4 +1,4 @@
-//! Fav CLI
+//! `fav_cli` is a CLI for [Fav](https://github.com/kingwingfly/fav).
 
 #![deny(missing_docs, rustdoc::broken_intra_doc_links)]
 #![cfg_attr(all(doc, CHANNEL_NIGHTLY), feature(doc_auto_cfg))]
diff --git a/fav_core/src/lib.rs b/fav_core/src/lib.rs
@@ -1,4 +1,5 @@
-//! Fav Core is a crate for `Fav`, a CLI tool to sync one's favorite remote resources
+//! Fav Core is a crate for [Fav](https://github.com/kingwingfly/fav),
+//! a CLI tool to sync one's favorite remote resources.
 
 #![deny(missing_docs, rustdoc::broken_intra_doc_links)]
 #![cfg_attr(all(doc, CHANNEL_NIGHTLY), feature(doc_auto_cfg))]

diff --git a/fav_derive/src/lib.rs b/fav_derive/src/lib.rs
@@ -1,4 +1,4 @@
-//! `fac_derive` is a crate for `fac_core` to derive traits.
+//! `fav_derive` is a crate for [fav_core](https://docs.rs/fav_core) to derive traits.
 
 #![deny(missing_docs, rustdoc::broken_intra_doc_links)]
 #![cfg_attr(all(doc, CHANNEL_NIGHTLY), feature(doc_auto_cfg))]

diff --git a/fav_utils/src/lib.rs b/fav_utils/src/lib.rs
@@ -1,4 +1,4 @@
-//! helper functions for the CLI
+//! `fav_utils` is a utility library for [Fav](https://github.com/kingwingfly/fav).
 
 #![deny(missing_docs, rustdoc::broken_intra_doc_links)]
 #![cfg_attr(all(doc, CHANNEL_NIGHTLY), feature(doc_auto_cfg))]