Merge branch 'master' into doc-fix-default-service

.github/workflows/clippy-fmt.yml

@@ -46,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

actix-files/src/named.rs

@@ -209,6 +209,7 @@ impl NamedFile {
         Self::from_file(file, path)
     }
 
+    #[allow(rustdoc::broken_intra_doc_links)]
     /// Attempts to open a file asynchronously in read-only mode.
     ///
     /// When the `experimental-io-uring` crate feature is enabled, this will be async.
@@ -298,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);