From 21a08ca7969e9a08035a4b9e78d8419f3cce3c64 Mon Sep 17 00:00:00 2001
From: Rob Ede <robjtede@icloud.com>
Date: Fri, 28 Jan 2022 20:27:16 +0000
Subject: [PATCH] tweak set_content_encoding docs

---
 .github/workflows/clippy-fmt.yml | 36 ++++++++++++++++----------------
 actix-files/src/named.rs         |  6 ++++--
 2 files changed, 22 insertions(+), 20 deletions(-)

diff --git a/.github/workflows/clippy-fmt.yml b/.github/workflows/clippy-fmt.yml
index 9f5a0570a..bc2cec145 100644
--- a/.github/workflows/clippy-fmt.yml
+++ b/.github/workflows/clippy-fmt.yml
@@ -5,24 +5,6 @@ on:
     types: [opened, synchronize, reopened]
 
 jobs:
-  lint-docs:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Install Rust
-        uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-          profile: minimal
-          components: rust-docs
-      - name: Check for broken intra-doc links
-        uses: actions-rs/cargo@v1
-        env:
-          RUSTDOCFLAGS: "-D warnings"
-        with:
-          command: doc
-          args: --no-deps --all-features --workspace
-
   fmt:
     runs-on: ubuntu-latest
     steps:
@@ -64,3 +46,21 @@ jobs:
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           args: --workspace --tests --examples --all-features
+
+  lint-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          profile: minimal
+          components: rust-docs
+      - name: Check for broken intra-doc links
+        uses: actions-rs/cargo@v1
+        env:
+          RUSTDOCFLAGS: "-D warnings"
+        with:
+          command: doc
+          args: --no-deps --all-features --workspace
diff --git a/actix-files/src/named.rs b/actix-files/src/named.rs
index cb6875065..baf9b5531 100644
--- a/actix-files/src/named.rs
+++ b/actix-files/src/named.rs
@@ -299,9 +299,11 @@ impl NamedFile {
         self
     }
 
-    /// Set content encoding for serving this file
+    /// Sets content encoding for this file.
     ///
-    /// Must be used with `actix_web::middleware::Compress` to take effect.
+    /// This prevents the `Compress` middleware from modifying the file contents and signals to
+    /// browsers/clients how to decode it. For example, if serving a compressed HTML file (e.g.,
+    /// `index.html.gz`) then use `.set_content_encoding(ContentEncoding::Gzip)`.
     #[inline]
     pub fn set_content_encoding(mut self, enc: ContentEncoding) -> Self {
         self.encoding = Some(enc);