Skip to content

Commit 80d519e

Browse files
author
Harry Barber
committed
Improve documentation
1 parent efe4d4d commit 80d519e

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

rust-runtime/aws-smithy-http-server/src/logging/plugin.rs

+4-2
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,10 @@ where
3434

3535
/// An extension trait for applying [`InstrumentLayer`] to all operations.
3636
pub trait InstrumentExt: Pluggable<InstrumentPlugin> {
37-
/// Applies [`InstrumentLayer`] to all operations. See [`InstrumentOperation`](super::InstrumentOperation) for more
38-
/// information.
37+
/// Applies an [`InstrumentLayer`] to all operations which respects the [@sensitive] trait given on the input and
38+
/// output models. See [`InstrumentOperation`](super::InstrumentOperation) for more information.
39+
///
40+
/// [@sensitive]: https://awslabs.github.io/smithy/2.0/spec/documentation-traits.html#sensitive-trait
3941
fn instrument(self) -> Self::Output
4042
where
4143
Self: Sized,

rust-runtime/aws-smithy-http-server/src/logging/sensitivity/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ pub const REDACTED: &str = "{redacted}";
3030
pub trait Sensitivity {
3131
/// The [`MakeDebug`] and [`MakeDisplay`] for the request [`HeaderMap`] and [`Uri`].
3232
type RequestFmt: for<'a> MakeDebug<&'a HeaderMap> + for<'a> MakeDisplay<&'a Uri>;
33-
/// The [`MakeDebug`] and [`MakeDisplay`] for the response [`HeaderMap`] and [`Uri`].
33+
/// The [`MakeDebug`] and [`MakeDisplay`] for the response [`HeaderMap`] and [`StatusCode`].
3434
type ResponseFmt: for<'a> MakeDebug<&'a HeaderMap> + MakeDisplay<StatusCode>;
3535

3636
/// Returns the [`RequestFmt`](Sensitivity::RequestFmt).

0 commit comments

Comments
 (0)