Improve documentation

smithy-lang · Sep 20, 2022 · 80d519e · 80d519e
1 parent efe4d4d
commit 80d519e
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/rust-runtime/aws-smithy-http-server/src/logging/plugin.rs b/rust-runtime/aws-smithy-http-server/src/logging/plugin.rs
@@ -34,8 +34,10 @@ where
 
 /// An extension trait for applying [`InstrumentLayer`] to all operations.
 pub trait InstrumentExt: Pluggable<InstrumentPlugin> {
-    /// Applies [`InstrumentLayer`] to all operations. See [`InstrumentOperation`](super::InstrumentOperation) for more
-    /// information.
+    /// Applies an [`InstrumentLayer`] to all operations which respects the [@sensitive] trait given on the input and
+    /// output models. See [`InstrumentOperation`](super::InstrumentOperation) for more information.
+    ///
+    /// [@sensitive]: https://awslabs.github.io/smithy/2.0/spec/documentation-traits.html#sensitive-trait
     fn instrument(self) -> Self::Output
     where
         Self: Sized,

diff --git a/rust-runtime/aws-smithy-http-server/src/logging/sensitivity/mod.rs b/rust-runtime/aws-smithy-http-server/src/logging/sensitivity/mod.rs
@@ -30,7 +30,7 @@ pub const REDACTED: &str = "{redacted}";
 pub trait Sensitivity {
     /// The [`MakeDebug`] and [`MakeDisplay`] for the request [`HeaderMap`] and [`Uri`].
     type RequestFmt: for<'a> MakeDebug<&'a HeaderMap> + for<'a> MakeDisplay<&'a Uri>;
-    /// The [`MakeDebug`] and [`MakeDisplay`] for the response [`HeaderMap`] and [`Uri`].
+    /// The [`MakeDebug`] and [`MakeDisplay`] for the response [`HeaderMap`] and [`StatusCode`].
     type ResponseFmt: for<'a> MakeDebug<&'a HeaderMap> + MakeDisplay<StatusCode>;
 
     /// Returns the [`RequestFmt`](Sensitivity::RequestFmt).