From c7a0af31d3bb05f08e2b22100d8c835273d029f1 Mon Sep 17 00:00:00 2001 From: Rob Ede Date: Sat, 16 Dec 2023 10:20:28 +0000 Subject: [PATCH] docs: doc and metadata tweaks --- actix-http/Cargo.toml | 2 +- actix-http/README.md | 10 +++++++--- actix-http/src/lib.rs | 3 ++- actix-router/src/resource.rs | 4 ++-- actix-web/Cargo.toml | 2 +- actix-web/src/redirect.rs | 2 +- scripts/bump | 5 ++++- 7 files changed, 18 insertions(+), 10 deletions(-) diff --git a/actix-http/Cargo.toml b/actix-http/Cargo.toml index f483ea093da..8476d908605 100644 --- a/actix-http/Cargo.toml +++ b/actix-http/Cargo.toml @@ -5,7 +5,7 @@ authors = [ "Nikolay Kim ", "Rob Ede ", ] -description = "HTTP primitives for the Actix ecosystem" +description = "HTTP types and services for the Actix ecosystem" keywords = ["actix", "http", "framework", "async", "futures"] homepage = "https://actix.rs" repository = "https://github.com/actix/actix-web" diff --git a/actix-http/README.md b/actix-http/README.md index 049de9278f9..7d499f4b357 100644 --- a/actix-http/README.md +++ b/actix-http/README.md @@ -1,6 +1,8 @@ -# actix-http +# `actix-http` -> HTTP primitives for the Actix ecosystem. +> HTTP types and services for the Actix ecosystem. + + [![crates.io](https://img.shields.io/crates/v/actix-http?label=latest)](https://crates.io/crates/actix-http) [![Documentation](https://docs.rs/actix-http/badge.svg?version=3.4.0)](https://docs.rs/actix-http/3.4.0) @@ -11,12 +13,14 @@ [![Download](https://img.shields.io/crates/d/actix-http.svg)](https://crates.io/crates/actix-http) [![Chat on Discord](https://img.shields.io/discord/771444961383153695?label=chat&logo=discord)](https://discord.gg/NWpN5mmg3x) + + ## Documentation & Resources - [API Documentation](https://docs.rs/actix-http) - Minimum Supported Rust Version (MSRV): 1.68 -## Example +## Examples ```rust use std::{env, io}; diff --git a/actix-http/src/lib.rs b/actix-http/src/lib.rs index 382295fbc5c..976697ca688 100644 --- a/actix-http/src/lib.rs +++ b/actix-http/src/lib.rs @@ -1,6 +1,7 @@ -//! HTTP primitives for the Actix ecosystem. +//! HTTP types and services for the Actix ecosystem. //! //! ## Crate Features +//! //! | Feature | Functionality | //! | ------------------- | ------------------------------------------- | //! | `http2` | HTTP/2 support via [h2]. | diff --git a/actix-router/src/resource.rs b/actix-router/src/resource.rs index 80c0a2d68c7..abd132211fc 100644 --- a/actix-router/src/resource.rs +++ b/actix-router/src/resource.rs @@ -193,8 +193,8 @@ const REGEX_FLAGS: &str = "(?s-m)"; /// # Trailing Slashes /// It should be noted that this library takes no steps to normalize intra-path or trailing slashes. /// As such, all resource definitions implicitly expect a pre-processing step to normalize paths if -/// they you wish to accommodate "recoverable" path errors. Below are several examples of -/// resource-path pairs that would not be compatible. +/// you wish to accommodate "recoverable" path errors. Below are several examples of resource-path +/// pairs that would not be compatible. /// /// ## Examples /// ``` diff --git a/actix-web/Cargo.toml b/actix-web/Cargo.toml index c9aab17b224..d9cf0b94f92 100644 --- a/actix-web/Cargo.toml +++ b/actix-web/Cargo.toml @@ -15,7 +15,7 @@ categories = [ ] homepage = "https://actix.rs" repository = "https://github.com/actix/actix-web" -license = "MIT OR Apache-2.0" +license.workspace = true edition.workspace = true rust-version.workspace = true diff --git a/actix-web/src/redirect.rs b/actix-web/src/redirect.rs index f9e9f2d7a0b..5ce960aa4a3 100644 --- a/actix-web/src/redirect.rs +++ b/actix-web/src/redirect.rs @@ -171,7 +171,7 @@ impl Responder for Redirect { } else { log::error!( "redirect target location can not be converted to header value: {:?}", - self.to + self.to, ); } diff --git a/scripts/bump b/scripts/bump index baf3fb4d85e..9d90542c6f1 100755 --- a/scripts/bump +++ b/scripts/bump @@ -93,9 +93,12 @@ fi # done; remove backup files rm -f $CARGO_MANIFEST.bak -rm -f $CHANGELOG_FILE.bak rm -f $README_FILE.bak +if [ -n "${CHANGELOG_FILE-}" ]; then + rm -f $CHANGELOG_FILE.bak +fi + echo "manifest, changelog, and readme updated" echo echo "check other references:"