From c8e641d4b671a07f2f5741dca68ad1e54782e957 Mon Sep 17 00:00:00 2001 From: Luca Bruno Date: Fri, 16 Oct 2020 22:01:30 +0000 Subject: [PATCH] cors: hide service struct from docs (#118) This hides `CorsMiddleware` from rustdocs, following the pattern of the rest of `actix_web::middleware` implementations. --- actix-cors/CHANGES.md | 2 ++ actix-cors/src/middleware.rs | 1 + 2 files changed, 3 insertions(+) diff --git a/actix-cors/CHANGES.md b/actix-cors/CHANGES.md index b19b21f19..90646a1e3 100644 --- a/actix-cors/CHANGES.md +++ b/actix-cors/CHANGES.md @@ -2,8 +2,10 @@ ## Unreleased - 2020-xx-xx * Disallow `*` in `Cors::allowed_origin` by panicking. [#114]. +* Hide `CorsMiddleware` from rustdocs. [#118]. [#114]: https://github.com/actix/actix-extras/pull/114 +[#118]: https://github.com/actix/actix-extras/pull/118 ## 0.4.1 - 2020-10-07 diff --git a/actix-cors/src/middleware.rs b/actix-cors/src/middleware.rs index 4e9c2bafb..86aa11c09 100644 --- a/actix-cors/src/middleware.rs +++ b/actix-cors/src/middleware.rs @@ -21,6 +21,7 @@ use crate::Inner; /// /// This struct contains the settings for CORS requests to be validated and for responses to /// be generated. +#[doc(hidden)] #[derive(Debug, Clone)] pub struct CorsMiddleware { pub(crate) service: S,