Skip to content

feat(ci): build and check rustdocs for warnings; fix(docs): add missing cfg flag to allow displaying features on doc.rs, fix various warnings #998

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/workflows/check-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Check rustdocs
# this is its own workflow since we to to use unstable
# to have the docs.rs display of feature flags

on:
push:
paths:
- 'lambda-runtime/**'
- 'lambda-runtime-api-client/**'
- 'lambda-http/**'
- 'lambda-events/**'
- 'lambda-extension/**'
- 'Cargo.toml'

pull_request:
paths:
- 'lambda-runtime/**'
- 'lambda-runtime-api-client/**'
- 'lambda-http/**'
- 'lambda-events/**'
- 'lambda-extension/**'
- 'Cargo.toml'

jobs:
build-runtime:
runs-on: ubuntu-latest

env:
RUST_BACKTRACE: 1
steps:
- uses: actions/checkout@v3
- uses: dtolnay/rust-toolchain@nightly

- name: Check documentation
shell: bash
env:
RUSTFLAGS: --cfg docsrs
RUSTDOCFLAGS: --cfg docsrs -Dwarnings
Copy link
Contributor Author

@jlizen jlizen May 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dwarnings results in failing on warnings

run: cargo doc --no-deps --document-private-items --all-features
2 changes: 1 addition & 1 deletion examples/advanced-sqs-partial-batch-failures/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ async fn main() -> Result<(), Error> {
/// Important note: your lambda sqs trigger *needs* to be configured with partial batch response support
/// with the ` ReportBatchItemFailures` flag set to true, otherwise failed message will be dropped,
/// for more details see:
/// https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-batchfailurereporting
/// <https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-batchfailurereporting>
///
///
/// Note that if you are looking for parallel processing (multithread) instead of concurrent processing,
Expand Down
2 changes: 1 addition & 1 deletion examples/basic-error-handling/src/main.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/// See https://github.com/awslabs/aws-lambda-rust-runtime for more info on Rust runtime for AWS Lambda
/// See <https://github.com/awslabs/aws-lambda-rust-runtime> for more info on Rust runtime for AWS Lambda
use lambda_runtime::{service_fn, tracing, Error, LambdaEvent};
use serde::{Deserialize, Serialize};
use serde_json::json;
Expand Down
2 changes: 1 addition & 1 deletion examples/http-basic-lambda/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use lambda_http::{run, service_fn, tracing, Body, Error, Request, Response};
/// This is the main body for the function.
/// Write your code inside it.
/// There are some code examples in the Runtime repository:
/// - https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/examples
/// - <https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/examples>
async fn function_handler(_event: Request) -> Result<Response<Body>, Error> {
// Extract some useful information from the request

Expand Down
2 changes: 1 addition & 1 deletion examples/http-dynamodb/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ pub struct Item {
/// This is the main body for the function.
/// Write your code inside it.
/// You can see more examples in Runtime's repository:
/// - https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/examples
/// - <https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/examples>
async fn handle_request(db_client: &Client, event: Request) -> Result<Response<Body>, Error> {
// Extract some useful information from the request
let body = event.body();
Expand Down
2 changes: 1 addition & 1 deletion examples/http-query-parameters/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use lambda_http::{run, service_fn, tracing, Error, IntoResponse, Request, Reques
/// This is the main body for the function.
/// Write your code inside it.
/// You can see more examples in Runtime's repository:
/// - https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/examples
/// - <https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/examples>
async fn function_handler(event: Request) -> Result<impl IntoResponse, Error> {
// Extract some useful information from the request
Ok(
Expand Down
1 change: 0 additions & 1 deletion lambda-events/src/custom_serde/float_unix_epoch.rs
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ where
struct SecondsFloatTimestampVisitor;

/// Serialize a UTC datetime into an float number of seconds since the epoch
/// ```
pub fn serialize<S>(dt: &DateTime<Utc>, serializer: S) -> Result<S::Ok, S::Error>
where
S: ser::Serializer,
Expand Down
2 changes: 1 addition & 1 deletion lambda-events/src/custom_serde/headers.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use serde::{
};
use std::{borrow::Cow, fmt};

/// Serialize a http::HeaderMap into a serde str => Vec<str> map
/// Serialize a http::HeaderMap into a serde str => `Vec<str>` map
pub(crate) fn serialize_multi_value_headers<S>(headers: &HeaderMap, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
Expand Down
2 changes: 1 addition & 1 deletion lambda-events/src/event/appsync/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ use std::collections::HashMap;

use crate::custom_serde::deserialize_lambda_map;

/// 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..
/// 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..
#[derive(Debug, Clone, Eq, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct AppSyncResolverTemplate<T1 = Value>
Expand Down
2 changes: 1 addition & 1 deletion lambda-events/src/event/cloudformation/provider.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
//!
//! Note that they are similar (but not the same) as the events in the `super` module.
//!
//! See https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html for details.
//! See <https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html> for details.

use serde::{de::DeserializeOwned, Deserialize, Serialize};
use serde_json::Value;
Expand Down
2 changes: 1 addition & 1 deletion lambda-events/src/event/cloudwatch_alarms/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ use serde_json::Value;
/// `CloudWatchAlarm` is the generic outer structure of an event triggered by a CloudWatch Alarm.
/// You probably want to use `CloudWatchMetricAlarm` or `CloudWatchCompositeAlarm` if you know which kind of alarm your function is receiving.
/// For examples of events that come via CloudWatch Alarms,
/// see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#Lambda-action-payload
/// see <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#Lambda-action-payload>
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct CloudWatchAlarm<C = Value, R = CloudWatchAlarmStateReasonData>
Expand Down
2 changes: 1 addition & 1 deletion lambda-events/src/event/cloudwatch_events/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ pub mod tag;
pub mod trustedadvisor;

/// `CloudWatchEvent` is the outer structure of an event sent via CloudWatch Events.
/// For examples of events that come via CloudWatch Events, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html
/// For examples of events that come via CloudWatch Events, see <https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html>
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct CloudWatchEvent<T1 = Value>
Expand Down
2 changes: 1 addition & 1 deletion lambda-events/src/event/codebuild/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ pub type CodeBuildPhaseStatus = String;
pub type CodeBuildPhaseType = String;

/// `CodeBuildEvent` is documented at:
/// https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-notifications.html#sample-build-notifications-ref
/// <https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-notifications.html#sample-build-notifications-ref>
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct CodeBuildEvent {
Expand Down
2 changes: 1 addition & 1 deletion lambda-events/src/event/codedeploy/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ use serde::{Deserialize, Serialize};
pub type CodeDeployDeploymentState = String;

/// `CodeDeployEvent` is documented at:
/// https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#acd_event_types
/// <https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#acd_event_types>
#[derive(Debug, Clone, Eq, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct CodeDeployEvent {
Expand Down
2 changes: 1 addition & 1 deletion lambda-events/src/event/codepipeline_cloudwatch/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ pub type CodePipelineState = String;
pub type CodePipelineActionState = String;

/// CodePipelineEvent is documented at:
/// https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#codepipeline_event_type
/// <https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#codepipeline_event_type>
#[derive(Debug, Clone, Eq, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct CodePipelineCloudWatchEvent {
Expand Down
8 changes: 4 additions & 4 deletions lambda-events/src/event/dynamodb/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -110,15 +110,15 @@ impl fmt::Display for KeyType {
}

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

/// `TimeWindowEvent` represents an Amazon Dynamodb event when using time windows
/// ref. https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-windows
/// ref. <https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-windows>
#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct TimeWindowEvent {
Expand Down Expand Up @@ -215,8 +215,8 @@ pub struct UserIdentity {
#[serde(rename_all = "camelCase")]
pub struct StreamRecord {
/// The approximate date and time when the stream record was created, in UNIX
/// epoch time (http://www.epochconverter.com/) format. Might not be present in
/// the record: https://github.com/awslabs/aws-lambda-rust-runtime/issues/889
/// epoch time (<http://www.epochconverter.com/>) format. Might not be present in
/// the record: <https://github.com/awslabs/aws-lambda-rust-runtime/issues/889>
#[serde(rename = "ApproximateCreationDateTime")]
#[serde(with = "float_unix_epoch")]
#[serde(default)]
Expand Down
2 changes: 1 addition & 1 deletion lambda-events/src/event/eventbridge/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use serde_json::Value;
/// Parse EventBridge events.
/// Deserialize the event detail into a structure that's `DeserializeOwned`.
///
/// See https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events-structure.html for structure details.
/// See <https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events-structure.html> for structure details.
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
#[serde(bound(deserialize = "T1: DeserializeOwned"))]
#[serde(rename_all = "kebab-case")]
Expand Down
4 changes: 2 additions & 2 deletions lambda-events/src/event/iot/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use http::HeaderMap;
use serde::{Deserialize, Serialize};

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

/// `IoTCoreCustomAuthorizerResponse` represents the response from an IoT Core custom authorizer.
/// See https://docs.aws.amazon.com/iot/latest/developerguide/config-custom-auth.html
/// See <https://docs.aws.amazon.com/iot/latest/developerguide/config-custom-auth.html>
#[derive(Debug, Clone, Eq, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct IoTCoreCustomAuthorizerResponse {
Expand Down
2 changes: 1 addition & 1 deletion lambda-events/src/event/kinesis/event.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ pub struct KinesisEvent {
}

/// `KinesisTimeWindowEvent` represents an Amazon Dynamodb event when using time windows
/// ref. https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-windows
/// ref. <https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-windows>
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct KinesisTimeWindowEvent {
Expand Down
2 changes: 1 addition & 1 deletion lambda-events/src/event/s3/object_lambda.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use std::collections::HashMap;
use crate::custom_serde::{deserialize_headers, serialize_headers};

/// `S3ObjectLambdaEvent` contains data coming from S3 object lambdas
/// See: https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-writing-lambda.html
/// See: <https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-writing-lambda.html>
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct S3ObjectLambdaEvent<P = Value>
Expand Down
2 changes: 1 addition & 1 deletion lambda-events/src/event/sqs/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ pub struct SqsApiEvent {
pub messages: Vec<SqsApiMessage>,
}

/// Alternative to SqsApiEvent to be used alongside SqsApiMessageObj<T> when you need to
/// Alternative to SqsApiEvent to be used alongside `SqsApiMessageObj<T>` when you need to
/// deserialize a nested object into a struct of type T within the SQS Message rather
/// than just using the raw SQS Message string
#[serde_with::serde_as]
Expand Down
1 change: 1 addition & 0 deletions lambda-events/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
#![deny(rust_2018_idioms)]
#![cfg_attr(docsrs, feature(doc_cfg))]
#[cfg(feature = "http")]
pub use http;
#[cfg(feature = "query_map")]
Expand Down
12 changes: 6 additions & 6 deletions lambda-events/src/time_window.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ use std::collections::HashMap;
use crate::custom_serde::deserialize_lambda_map;

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

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

/// `TimeWindowEventResponseProperties` is the object that captures response properties that relate to the tumbling windows feature
/// Kinesis: https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-windows
/// DDB: https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-windows
/// Kinesis: <https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-windows>
/// DDB: <https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-windows>
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct TimeWindowEventResponseProperties {
Expand Down
1 change: 1 addition & 0 deletions lambda-extension/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#![deny(clippy::all, clippy::cargo)]
#![allow(clippy::multiple_crate_versions, clippy::type_complexity)]
#![warn(missing_docs, nonstandard_style, rust_2018_idioms)]
#![cfg_attr(docsrs, feature(doc_cfg))]

//! This module includes utilities to create Lambda Runtime Extensions.
//!
Expand Down
2 changes: 1 addition & 1 deletion lambda-extension/src/logs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ use tracing::{error, trace};
use crate::{Error, ExtensionError};

/// Payload received from the Lambda Logs API
/// See: https://docs.aws.amazon.com/lambda/latest/dg/runtimes-logs-api.html#runtimes-logs-api-msg
/// See: <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-logs-api.html#runtimes-logs-api-msg>
#[derive(Clone, Debug, Deserialize, PartialEq)]
pub struct LambdaLog {
/// Time when the log was generated
Expand Down
3 changes: 2 additions & 1 deletion lambda-http/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
#![warn(missing_docs, rust_2018_idioms)]
#![cfg_attr(docsrs, feature(doc_cfg))]
//#![deny(warnings)]
//! Enriches the `lambda` crate with [`http`](https://github.com/hyperium/http)
//! types targeting AWS [ALB](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/introduction.html), [API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html) REST and HTTP API lambda integrations.
Expand Down Expand Up @@ -188,7 +189,7 @@ where
/// Runtime APIs](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-api.html).
///
/// This takes care of transforming the LambdaEvent into a [`Request`] and then
/// converting the result into a [`LambdaResponse`].
/// converting the result into a `LambdaResponse`.
pub async fn run<'a, R, S, E>(handler: S) -> Result<(), Error>
where
S: Service<Request, Response = R, Error = E>,
Expand Down
2 changes: 1 addition & 1 deletion lambda-http/src/response.rs
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ impl LambdaResponse {
///
/// Types that implement this trait can be used as return types for handler functions.
pub trait IntoResponse {
/// Transform into a Response<Body> Future
/// Transform into a `Response<Body>` Future
fn into_response(self) -> ResponseFuture;
}

Expand Down
4 changes: 2 additions & 2 deletions lambda-runtime-api-client/src/body/channel.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//! Body::channel utilities. Extracted from Hyper under MIT license.
//! https://github.com/hyperium/hyper/blob/master/LICENSE
//! <https://github.com/hyperium/hyper/blob/master/LICENSE>

use std::{
pin::Pin,
Expand Down Expand Up @@ -31,7 +31,7 @@ impl DecodedLength {
}
}

/// Converts to an Option<u64> representing a Known or Unknown length.
/// Converts to an `Option<u64>` representing a Known or Unknown length.
pub(crate) fn into_opt(self) -> Option<u64> {
match self {
DecodedLength::CHUNKED | DecodedLength::CLOSE_DELIMITED => None,
Expand Down
2 changes: 1 addition & 1 deletion lambda-runtime-api-client/src/body/mod.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//! HTTP body utilities. Extracted from Axum under MIT license.
//! https://github.com/tokio-rs/axum/blob/main/axum/LICENSE
//! <https://github.com/tokio-rs/axum/blob/main/axum/LICENSE>

use crate::{BoxError, Error};
use bytes::Bytes;
Expand Down
2 changes: 1 addition & 1 deletion lambda-runtime-api-client/src/body/sender.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//! Body::channel utilities. Extracted from Hyper under MIT license.
//! https://github.com/hyperium/hyper/blob/master/LICENSE
//! <https://github.com/hyperium/hyper/blob/master/LICENSE>

use crate::Error;
use std::task::{Context, Poll};
Expand Down
2 changes: 1 addition & 1 deletion lambda-runtime-api-client/src/body/watch.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//! Body::channel utilities. Extracted from Hyper under MIT license.
//! https://github.com/hyperium/hyper/blob/master/LICENSE
//! <https://github.com/hyperium/hyper/blob/master/LICENSE>

//! An SPSC broadcast channel.
//!
Expand Down
2 changes: 1 addition & 1 deletion lambda-runtime-api-client/src/error.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//! Extracted from Axum under MIT license.
//! https://github.com/tokio-rs/axum/blob/main/axum/LICENSE
//! <https://github.com/tokio-rs/axum/blob/main/axum/LICENSE>
use std::{error::Error as StdError, fmt};
pub use tower::BoxError;
/// Errors that can happen when using axum.
Expand Down
1 change: 1 addition & 0 deletions lambda-runtime-api-client/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#![deny(clippy::all, clippy::cargo)]
#![warn(missing_docs, nonstandard_style, rust_2018_idioms)]
#![allow(clippy::multiple_crate_versions)]
#![cfg_attr(docsrs, feature(doc_cfg))]

//! This crate includes a base HTTP client to interact with
//! the AWS Lambda Runtime API.
Expand Down
2 changes: 1 addition & 1 deletion lambda-runtime-api-client/src/tracing.rs
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ pub fn init_default_subscriber() {
///
/// 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
/// 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).
/// In that case, you might prefer to use [tracing_appender::NonBlocking] instead - particularly if your Lambda is fairly long-running and stays warm.
/// 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.
/// Though, note that you are then responsible
/// for ensuring gracefuls shutdown. See [`examples/graceful-shutdown`] for a complete example.
///
Expand Down
2 changes: 1 addition & 1 deletion lambda-runtime/src/layers/otel.rs
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ where
}

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