diff options
| author | Owen Jacobson <owen@grimoire.ca> | 2024-09-25 01:22:07 -0400 |
|---|---|---|
| committer | Owen Jacobson <owen@grimoire.ca> | 2024-09-25 02:15:25 -0400 |
| commit | 697e90f291cec1bbd89965c2731f9481ec4507c4 (patch) | |
| tree | b40ef7142da474b0ad2bd370b2c89d2008570976 /src/repo/channel.rs | |
| parent | af7ece7dd5433051d67526ae15ad64f0f5b5e568 (diff) | |
rustdoc comment for the (very limited) public API of the crate.
This silences some `-Wclippy::pedantic` warning, and it's just a good thing to do.
I've made the choice to have the docs comment face programmers, and to provide `hi --help` and `hi -h` content via Clap attributes instead of inferring it from the docs comment.
Internal (private) "rustdoc" comments have been converted to regular comments until I learn how to write better rustdoc.
Diffstat (limited to 'src/repo/channel.rs')
| -rw-r--r-- | src/repo/channel.rs | 3 |
1 files changed, 1 insertions, 2 deletions
diff --git a/src/repo/channel.rs b/src/repo/channel.rs index da63b45..0186413 100644 --- a/src/repo/channel.rs +++ b/src/repo/channel.rs @@ -23,7 +23,6 @@ pub struct Channel { } impl<'c> Channels<'c> { - /// Create a new channel. pub async fn create(&mut self, name: &str) -> Result<Channel, sqlx::Error> { let id = Id::generate(); @@ -78,7 +77,7 @@ impl<'c> Channels<'c> { } } -/// Stable identifier for a [Channel]. Prefixed with `C`. +// Stable identifier for a [Channel]. Prefixed with `C`. #[derive( Clone, Debug, |