From 7a82288066ea434349d9850eef63e4fae17a56d0 Mon Sep 17 00:00:00 2001 From: Rob Ede Date: Thu, 15 Apr 2021 21:58:18 +0100 Subject: [PATCH] docs tweak --- actix-service/src/lib.rs | 3 ++- actix-service/src/macros.rs | 8 ++++---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/actix-service/src/lib.rs b/actix-service/src/lib.rs index e83323a3..3ae22679 100644 --- a/actix-service/src/lib.rs +++ b/actix-service/src/lib.rs @@ -2,6 +2,7 @@ #![no_std] #![deny(rust_2018_idioms, nonstandard_style)] +#![warn(missing_docs)] #![allow(clippy::type_complexity)] #![doc(html_logo_url = "https://actix.rs/img/logo.png")] #![doc(html_favicon_url = "https://actix.rs/favicon.ico")] @@ -59,7 +60,7 @@ use self::ready::{err, ok, ready, Ready}; /// response type. /// /// Services can also have mutable state that influence computation by using a `Cell`, `RefCell` -/// or `Mutex`. Services intentionally do not take `&mut self` to reduce over-head in the +/// or `Mutex`. Services intentionally do not take `&mut self` to reduce overhead in the /// common cases. /// /// `Service` provides a symmetric and uniform API; the same abstractions can be used to represent diff --git a/actix-service/src/macros.rs b/actix-service/src/macros.rs index d2ae9dbf..e23b2960 100644 --- a/actix-service/src/macros.rs +++ b/actix-service/src/macros.rs @@ -1,6 +1,6 @@ -/// A boilerplate implementation of [`Service::poll_ready`] that always signals readiness. +/// An implementation of [`poll_ready`]() that always signals readiness. /// -/// [`Service::poll_ready`]: crate::Service::poll_ready +/// [`poll_ready`]: crate::Service::poll_ready /// /// # Examples /// ```no_run @@ -34,12 +34,12 @@ macro_rules! always_ready { }; } -/// A boilerplate implementation of [`Service::poll_ready`] that forwards readiness checks to a +/// An implementation of [`poll_ready`] that forwards readiness checks to a /// named struct field. /// /// Tuple structs are not supported. /// -/// [`Service::poll_ready`]: crate::Service::poll_ready +/// [`poll_ready`]: crate::Service::poll_ready /// /// # Examples /// ```no_run