From 697e90f291cec1bbd89965c2731f9481ec4507c4 Mon Sep 17 00:00:00 2001 From: Owen Jacobson Date: Wed, 25 Sep 2024 01:22:07 -0400 Subject: 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. --- src/events/extract.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'src/events/extract.rs') diff --git a/src/events/extract.rs b/src/events/extract.rs index 683c1f9..44bcc71 100644 --- a/src/events/extract.rs +++ b/src/events/extract.rs @@ -7,8 +7,8 @@ use axum::{ use axum_extra::typed_header::TypedHeader; use serde::{de::DeserializeOwned, Serialize}; -/// A typed header. When used as a bare extractor, reads from the -/// `Last-Event-Id` HTTP header. +// A typed header. When used as a bare extractor, reads from the +// `Last-Event-Id` HTTP header. pub struct LastEventId(pub T); static LAST_EVENT_ID: HeaderName = HeaderName::from_static("last-event-id"); -- cgit v1.2.3