docs: doc and metadata tweaks

actix · Dec 16, 2023 · c7a0af3 · c7a0af3
1 parent eefe8b0
commit c7a0af3
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 10 deletions.
diff --git a/actix-http/Cargo.toml b/actix-http/Cargo.toml
@@ -5,7 +5,7 @@ authors = [
  "Nikolay Kim <fafhrd91@gmail.com>",
  "Rob Ede <robjtede@icloud.com>",
 ]
-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
@@ -1,6 +1,8 @@
-# actix-http
+# `actix-http`
 
-> HTTP primitives for the Actix ecosystem.
+> HTTP types and services for the Actix ecosystem.
+
+<!-- prettier-ignore-start -->
 
 [![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)
 
+<!-- prettier-ignore-end -->
+
 ## 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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:"