Skip to content

Commit cbcad4f

Browse files
jlizenjlizen
committed
fix(docs): fix assorted rustdoc warnings
1 parent 12d308d commit cbcad4f

File tree

32 files changed

+43
-44
lines changed

32 files changed

+43
-44
lines changed

‎examples/advanced-sqs-partial-batch-failures/src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ async fn main() -> Result<(), Error> {
4444
/// Important note: your lambda sqs trigger *needs* to be configured with partial batch response support
4545
/// with the ` ReportBatchItemFailures` flag set to true, otherwise failed message will be dropped,
4646
/// for more details see:
47-
/// https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-batchfailurereporting
47+
/// <https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-batchfailurereporting>
4848
///
4949
///
5050
/// Note that if you are looking for parallel processing (multithread) instead of concurrent processing,

‎examples/basic-error-handling/src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/// See https://github.com/awslabs/aws-lambda-rust-runtime for more info on Rust runtime for AWS Lambda
1+
/// See <https://github.com/awslabs/aws-lambda-rust-runtime> for more info on Rust runtime for AWS Lambda
22
use lambda_runtime::{service_fn, tracing, Error, LambdaEvent};
33
use serde::{Deserialize, Serialize};
44
use serde_json::json;

‎examples/http-basic-lambda/src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use lambda_http::{run, service_fn, tracing, Body, Error, Request, Response};
33
/// This is the main body for the function.
44
/// Write your code inside it.
55
/// There are some code examples in the Runtime repository:
6-
/// - https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/examples
6+
/// - <https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/examples>
77
async fn function_handler(_event: Request) -> Result<Response<Body>, Error> {
88
// Extract some useful information from the request
99

‎examples/http-dynamodb/src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ pub struct Item {
1515
/// This is the main body for the function.
1616
/// Write your code inside it.
1717
/// You can see more examples in Runtime's repository:
18-
/// - https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/examples
18+
/// - <https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/examples>
1919
async fn handle_request(db_client: &Client, event: Request) -> Result<Response<Body>, Error> {
2020
// Extract some useful information from the request
2121
let body = event.body();

‎examples/http-query-parameters/src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use lambda_http::{run, service_fn, tracing, Error, IntoResponse, Request, Reques
33
/// This is the main body for the function.
44
/// Write your code inside it.
55
/// You can see more examples in Runtime's repository:
6-
/// - https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/examples
6+
/// - <https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/examples>
77
async fn function_handler(event: Request) -> Result<impl IntoResponse, Error> {
88
// Extract some useful information from the request
99
Ok(

‎lambda-events/src/custom_serde/float_unix_epoch.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@ where
5757
struct SecondsFloatTimestampVisitor;
5858

5959
/// Serialize a UTC datetime into an float number of seconds since the epoch
60-
/// ```
6160
pub fn serialize<S>(dt: &DateTime<Utc>, serializer: S) -> Result<S::Ok, S::Error>
6261
where
6362
S: ser::Serializer,

‎lambda-events/src/custom_serde/headers.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use serde::{
55
};
66
use std::{borrow::Cow, fmt};
77

8-
/// Serialize a http::HeaderMap into a serde str => Vec<str> map
8+
/// Serialize a http::HeaderMap into a serde str => `Vec<str>` map
99
pub(crate) fn serialize_multi_value_headers<S>(headers: &HeaderMap, serializer: S) -> Result<S::Ok, S::Error>
1010
where
1111
S: Serializer,

‎lambda-events/src/event/appsync/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ use std::collections::HashMap;
44

55
use crate::custom_serde::deserialize_lambda_map;
66

7-
/// Deprecated: `AppSyncResolverTemplate` does not represent resolver events sent by AppSync. Instead directly model your input schema, or use map[string]string, json.RawMessage, interface{}, etc..
7+
/// Deprecated: `AppSyncResolverTemplate` does not represent resolver events sent by AppSync. Instead directly model your input schema, or use `map[string]string`, `json.RawMessage`,` interface{}`, etc..
88
#[derive(Debug, Clone, Eq, PartialEq, Deserialize, Serialize)]
99
#[serde(rename_all = "camelCase")]
1010
pub struct AppSyncResolverTemplate<T1 = Value>

‎lambda-events/src/event/cloudformation/provider.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//!
33
//! Note that they are similar (but not the same) as the events in the `super` module.
44
//!
5-
//! See https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html for details.
5+
//! See <https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html> for details.
66
77
use serde::{de::DeserializeOwned, Deserialize, Serialize};
88
use serde_json::Value;

‎lambda-events/src/event/cloudwatch_alarms/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ use serde_json::Value;
1111
/// `CloudWatchAlarm` is the generic outer structure of an event triggered by a CloudWatch Alarm.
1212
/// You probably want to use `CloudWatchMetricAlarm` or `CloudWatchCompositeAlarm` if you know which kind of alarm your function is receiving.
1313
/// For examples of events that come via CloudWatch Alarms,
14-
/// see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#Lambda-action-payload
14+
/// see <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#Lambda-action-payload>
1515
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
1616
#[serde(rename_all = "camelCase")]
1717
pub struct CloudWatchAlarm<C = Value, R = CloudWatchAlarmStateReasonData>

‎lambda-events/src/event/cloudwatch_events/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ pub mod tag;
2020
pub mod trustedadvisor;
2121

2222
/// `CloudWatchEvent` is the outer structure of an event sent via CloudWatch Events.
23-
/// For examples of events that come via CloudWatch Events, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html
23+
/// For examples of events that come via CloudWatch Events, see <https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html>
2424
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
2525
#[serde(rename_all = "camelCase")]
2626
pub struct CloudWatchEvent<T1 = Value>

‎lambda-events/src/event/codebuild/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ pub type CodeBuildPhaseStatus = String;
1111
pub type CodeBuildPhaseType = String;
1212

1313
/// `CodeBuildEvent` is documented at:
14-
/// https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-notifications.html#sample-build-notifications-ref
14+
/// <https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-notifications.html#sample-build-notifications-ref>
1515
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
1616
#[serde(rename_all = "camelCase")]
1717
pub struct CodeBuildEvent {

‎lambda-events/src/event/codedeploy/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ use serde::{Deserialize, Serialize};
44
pub type CodeDeployDeploymentState = String;
55

66
/// `CodeDeployEvent` is documented at:
7-
/// https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#acd_event_types
7+
/// <https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#acd_event_types>
88
#[derive(Debug, Clone, Eq, PartialEq, Deserialize, Serialize)]
99
#[serde(rename_all = "camelCase")]
1010
pub struct CodeDeployEvent {

‎lambda-events/src/event/codepipeline_cloudwatch/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ pub type CodePipelineState = String;
88
pub type CodePipelineActionState = String;
99

1010
/// CodePipelineEvent is documented at:
11-
/// https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#codepipeline_event_type
11+
/// <https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#codepipeline_event_type>
1212
#[derive(Debug, Clone, Eq, PartialEq, Deserialize, Serialize)]
1313
#[serde(rename_all = "camelCase")]
1414
pub struct CodePipelineCloudWatchEvent {

‎lambda-events/src/event/dynamodb/mod.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,15 +110,15 @@ impl fmt::Display for KeyType {
110110
}
111111

112112
/// The `Event` stream event handled to Lambda
113-
/// http://docs.aws.amazon.com/lambda/latest/dg/eventsources.html#eventsources-ddb-update
113+
/// <http://docs.aws.amazon.com/lambda/latest/dg/eventsources.html#eventsources-ddb-update>
114114
#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
115115
pub struct Event {
116116
#[serde(rename = "Records")]
117117
pub records: Vec<EventRecord>,
118118
}
119119

120120
/// `TimeWindowEvent` represents an Amazon Dynamodb event when using time windows
121-
/// ref. https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-windows
121+
/// ref. <https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-windows>
122122
#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
123123
#[serde(rename_all = "camelCase")]
124124
pub struct TimeWindowEvent {
@@ -215,8 +215,8 @@ pub struct UserIdentity {
215215
#[serde(rename_all = "camelCase")]
216216
pub struct StreamRecord {
217217
/// The approximate date and time when the stream record was created, in UNIX
218-
/// epoch time (http://www.epochconverter.com/) format. Might not be present in
219-
/// the record: https://github.com/awslabs/aws-lambda-rust-runtime/issues/889
218+
/// epoch time (<http://www.epochconverter.com/>) format. Might not be present in
219+
/// the record: <https://github.com/awslabs/aws-lambda-rust-runtime/issues/889>
220220
#[serde(rename = "ApproximateCreationDateTime")]
221221
#[serde(with = "float_unix_epoch")]
222222
#[serde(default)]

‎lambda-events/src/event/eventbridge/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use serde_json::Value;
55
/// Parse EventBridge events.
66
/// Deserialize the event detail into a structure that's `DeserializeOwned`.
77
///
8-
/// See https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events-structure.html for structure details.
8+
/// See <https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events-structure.html> for structure details.
99
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
1010
#[serde(bound(deserialize = "T1: DeserializeOwned"))]
1111
#[serde(rename_all = "kebab-case")]

‎lambda-events/src/event/iot/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use http::HeaderMap;
33
use serde::{Deserialize, Serialize};
44

55
/// `IoTCoreCustomAuthorizerRequest` represents the request to an IoT Core custom authorizer.
6-
/// See https://docs.aws.amazon.com/iot/latest/developerguide/config-custom-auth.html
6+
/// See <https://docs.aws.amazon.com/iot/latest/developerguide/config-custom-auth.html>
77
#[derive(Debug, Clone, Eq, PartialEq, Deserialize, Serialize)]
88
#[serde(rename_all = "camelCase")]
99
pub struct IoTCoreCustomAuthorizerRequest {
@@ -58,7 +58,7 @@ pub struct IoTCoreConnectionMetadata {
5858
}
5959

6060
/// `IoTCoreCustomAuthorizerResponse` represents the response from an IoT Core custom authorizer.
61-
/// See https://docs.aws.amazon.com/iot/latest/developerguide/config-custom-auth.html
61+
/// See <https://docs.aws.amazon.com/iot/latest/developerguide/config-custom-auth.html>
6262
#[derive(Debug, Clone, Eq, PartialEq, Deserialize, Serialize)]
6363
#[serde(rename_all = "camelCase")]
6464
pub struct IoTCoreCustomAuthorizerResponse {

‎lambda-events/src/event/kinesis/event.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ pub struct KinesisEvent {
1212
}
1313

1414
/// `KinesisTimeWindowEvent` represents an Amazon Dynamodb event when using time windows
15-
/// ref. https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-windows
15+
/// ref. <https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-windows>
1616
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1717
#[serde(rename_all = "camelCase")]
1818
pub struct KinesisTimeWindowEvent {

‎lambda-events/src/event/s3/object_lambda.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ use std::collections::HashMap;
66
use crate::custom_serde::{deserialize_headers, serialize_headers};
77

88
/// `S3ObjectLambdaEvent` contains data coming from S3 object lambdas
9-
/// See: https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-writing-lambda.html
9+
/// See: <https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-writing-lambda.html>
1010
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
1111
#[serde(rename_all = "camelCase")]
1212
pub struct S3ObjectLambdaEvent<P = Value>

‎lambda-events/src/event/sqs/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ pub struct SqsApiEvent {
126126
pub messages: Vec<SqsApiMessage>,
127127
}
128128

129-
/// Alternative to SqsApiEvent to be used alongside SqsApiMessageObj<T> when you need to
129+
/// Alternative to SqsApiEvent to be used alongside `SqsApiMessageObj<T>` when you need to
130130
/// deserialize a nested object into a struct of type T within the SQS Message rather
131131
/// than just using the raw SQS Message string
132132
#[serde_with::serde_as]

‎lambda-events/src/time_window.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ use std::collections::HashMap;
55
use crate::custom_serde::deserialize_lambda_map;
66

77
/// `Window` is the object that captures the time window for the records in the event when using the tumbling windows feature
8-
/// Kinesis: https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-windows
9-
/// DDB: https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-windows
8+
/// Kinesis: <https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-windows>
9+
/// DDB: <https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-windows>
1010
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1111
#[serde(rename_all = "camelCase")]
1212
pub struct Window {
@@ -24,8 +24,8 @@ impl Default for Window {
2424
}
2525

2626
/// `TimeWindowProperties` is the object that captures properties that relate to the tumbling windows feature
27-
/// Kinesis: https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-windows
28-
/// DDB: https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-windows
27+
/// Kinesis: <https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-windows>
28+
/// DDB: <https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-windows>
2929
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
3030
#[serde(rename_all = "camelCase")]
3131
pub struct TimeWindowProperties {
@@ -51,8 +51,8 @@ pub struct TimeWindowProperties {
5151
}
5252

5353
/// `TimeWindowEventResponseProperties` is the object that captures response properties that relate to the tumbling windows feature
54-
/// Kinesis: https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-windows
55-
/// DDB: https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-windows
54+
/// Kinesis: <https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-windows>
55+
/// DDB: <https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-windows>
5656
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
5757
#[serde(rename_all = "camelCase")]
5858
pub struct TimeWindowEventResponseProperties {

‎lambda-extension/src/logs.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ use tracing::{error, trace};
1212
use crate::{Error, ExtensionError};
1313

1414
/// Payload received from the Lambda Logs API
15-
/// See: https://docs.aws.amazon.com/lambda/latest/dg/runtimes-logs-api.html#runtimes-logs-api-msg
15+
/// See: <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-logs-api.html#runtimes-logs-api-msg>
1616
#[derive(Clone, Debug, Deserialize, PartialEq)]
1717
pub struct LambdaLog {
1818
/// Time when the log was generated

‎lambda-http/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ where
189189
/// Runtime APIs](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-api.html).
190190
///
191191
/// This takes care of transforming the LambdaEvent into a [`Request`] and then
192-
/// converting the result into a [`LambdaResponse`].
192+
/// converting the result into a `LambdaResponse`.
193193
pub async fn run<'a, R, S, E>(handler: S) -> Result<(), Error>
194194
where
195195
S: Service<Request, Response = R, Error = E>,

‎lambda-http/src/response.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ impl LambdaResponse {
153153
///
154154
/// Types that implement this trait can be used as return types for handler functions.
155155
pub trait IntoResponse {
156-
/// Transform into a Response<Body> Future
156+
/// Transform into a `Response<Body>` Future
157157
fn into_response(self) -> ResponseFuture;
158158
}
159159

‎lambda-runtime-api-client/src/body/channel.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//! Body::channel utilities. Extracted from Hyper under MIT license.
2-
//! https://github.com/hyperium/hyper/blob/master/LICENSE
2+
//! <https://github.com/hyperium/hyper/blob/master/LICENSE>
33
44
use std::{
55
pin::Pin,
@@ -31,7 +31,7 @@ impl DecodedLength {
3131
}
3232
}
3333

34-
/// Converts to an Option<u64> representing a Known or Unknown length.
34+
/// Converts to an `Option<u64>` representing a Known or Unknown length.
3535
pub(crate) fn into_opt(self) -> Option<u64> {
3636
match self {
3737
DecodedLength::CHUNKED | DecodedLength::CLOSE_DELIMITED => None,

‎lambda-runtime-api-client/src/body/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//! HTTP body utilities. Extracted from Axum under MIT license.
2-
//! https://github.com/tokio-rs/axum/blob/main/axum/LICENSE
2+
//! <https://github.com/tokio-rs/axum/blob/main/axum/LICENSE>
33
44
use crate::{BoxError, Error};
55
use bytes::Bytes;

‎lambda-runtime-api-client/src/body/sender.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//! Body::channel utilities. Extracted from Hyper under MIT license.
2-
//! https://github.com/hyperium/hyper/blob/master/LICENSE
2+
//! <https://github.com/hyperium/hyper/blob/master/LICENSE>
33
44
use crate::Error;
55
use std::task::{Context, Poll};

‎lambda-runtime-api-client/src/body/watch.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//! Body::channel utilities. Extracted from Hyper under MIT license.
2-
//! https://github.com/hyperium/hyper/blob/master/LICENSE
2+
//! <https://github.com/hyperium/hyper/blob/master/LICENSE>
33
44
//! An SPSC broadcast channel.
55
//!

‎lambda-runtime-api-client/src/error.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//! Extracted from Axum under MIT license.
2-
//! https://github.com/tokio-rs/axum/blob/main/axum/LICENSE
2+
//! <https://github.com/tokio-rs/axum/blob/main/axum/LICENSE>
33
use std::{error::Error as StdError, fmt};
44
pub use tower::BoxError;
55
/// Errors that can happen when using axum.

‎lambda-runtime-api-client/src/tracing.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ pub fn init_default_subscriber() {
4242
///
4343
/// You might want to avoid writing to STDOUT in the local context via [`init_default_subscriber()`], if you have a high-throughput Lambdas that involve
4444
/// a lot of async concurrency. Since, writing to STDOUT can briefly block your tokio runtime - ref [tracing #2653](https://github.com/tokio-rs/tracing/issues/2653).
45-
/// In that case, you might prefer to use [tracing_appender::NonBlocking] instead - particularly if your Lambda is fairly long-running and stays warm.
45+
/// In that case, you might prefer to use [tracing_appender::NonBlocking](https://docs.rs/tracing-appender/latest/tracing_appender/non_blocking/struct.NonBlocking.html) instead - particularly if your Lambda is fairly long-running and stays warm.
4646
/// Though, note that you are then responsible
4747
/// for ensuring gracefuls shutdown. See [`examples/graceful-shutdown`] for a complete example.
4848
///

‎lambda-runtime/src/layers/otel.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ where
131131
}
132132

133133
/// Represent the possible values for the OpenTelemetry `faas.trigger` attribute.
134-
/// See https://opentelemetry.io/docs/specs/semconv/attributes-registry/faas/ for more details.
134+
/// See <https://opentelemetry.io/docs/specs/semconv/attributes-registry/faas/> for more details.
135135
#[derive(Default, Clone, Copy)]
136136
#[non_exhaustive]
137137
pub enum OpenTelemetryFaasTrigger {

‎lambda-runtime/src/lib.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ where
132132
///
133133
/// You can use this future to execute cleanup or flush related logic prior to runtime shutdown.
134134
///
135-
/// This function's returned future must be resolved prior to [lambda_runtime::run()].
135+
/// This function's returned future must be resolved prior to `lambda_runtime::run()`.
136136
///
137137
/// Note that this implicitly also registers and drives a no-op internal extension that subscribes to no events.
138138
/// This extension will be named `_lambda-rust-runtime-no-op-graceful-shutdown-helper`. This extension name
@@ -142,12 +142,12 @@ where
142142
/// registered already, you might prefer to manually construct your own graceful shutdown handling without the dummy extension.
143143
///
144144
/// For more information on general AWS Lambda graceful shutdown handling, see:
145-
/// https://github.com/aws-samples/graceful-shutdown-with-aws-lambda
145+
/// <https://github.com/aws-samples/graceful-shutdown-with-aws-lambda>
146146
///
147147
/// # Panics
148148
///
149149
/// This function panics if:
150-
/// - this function is called after [lambda_runtime::run()]
150+
/// - this function is called after `lambda_runtime::run()`
151151
/// - this function is called outside of a context that has access to the tokio i/o
152152
/// - the no-op extension cannot be registered
153153
/// - either signal listener panics [tokio::signal::unix](https://docs.rs/tokio/latest/tokio/signal/unix/fn.signal.html#errors)

0 commit comments

Comments
 (0)