Skip to content

Conversation

@joseluisq
Copy link
Collaborator

@joseluisq joseluisq commented Nov 26, 2025

Description

This PR fixes a couple of crate docs issues and improves CI to catch them properly.

1. doc_auto_cfg feature has been removed

error[E0557]: feature has been removed
   --> src/lib.rs:102:38
    |
102 | #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
    |                                      ^^^^^^^^^^^^ feature has been removed
    |
    = note: removed in 1.92.0; see <https://github.com/rust-lang/rust/pull/138907> for more information
    = note: merged into `doc_cfg`

error: Compilation failed, aborting rustdoc

For more information about this error, try `rustc --explain E0557`.
error: could not document `static-web-server`

2. bare URLs are not automatically turned into clickable links

warning: this URL is not a hyperlink
  --> src/directory_listing.rs:27:39
   |
27 | /// See 2.3.  Unreserved Characters - https://www.ietf.org/rfc/rfc3986.txt
   |                                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
   = note: bare URLs are not automatically turned into clickable links
note: the lint level is defined here
  --> src/lib.rs:99:9
   |
99 | #![deny(warnings)]
   |         ^^^^^^^^
   = note: `#[warn(rustdoc::bare_urls)]` implied by `#[warn(warnings)]`
help: use an automatic link instead
   |
27 | /// See 2.3.  Unreserved Characters - <https://www.ietf.org/rfc/rfc3986.txt>
   |                                       +                                    +

Related Issue

Motivation and Context

References https://docs.rs/crate/static-web-server/latest/builds/2610320

How Has This Been Tested?

Screenshots (if appropriate):

@joseluisq joseluisq added enhancement New feature or request v2 v2 release ci Related to CI/CD bugfix This is PR fixes a bug library Related to the static-web-server crate labels Nov 26, 2025
@semanticdiff-com
Copy link

semanticdiff-com bot commented Nov 26, 2025

Review changes with  SemanticDiff

Changed Files
File Status
  .github/workflows/devel.yml  13% smaller
  src/directory_listing.rs  0% smaller
  src/lib.rs  0% smaller

@joseluisq joseluisq force-pushed the check-crate-docs-on-ci branch from 6f94155 to a54509a Compare November 26, 2025 02:49
@joseluisq joseluisq force-pushed the check-crate-docs-on-ci branch from a54509a to 4fe60d7 Compare November 26, 2025 02:51
@joseluisq joseluisq marked this pull request as ready for review November 26, 2025 02:59
@joseluisq joseluisq merged commit 0fedeb3 into master Nov 26, 2025
27 of 37 checks passed
@joseluisq joseluisq deleted the check-crate-docs-on-ci branch November 26, 2025 03:12
@joseluisq joseluisq added this to the v2.40.0 milestone Nov 26, 2025
@joseluisq joseluisq self-assigned this Nov 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugfix This is PR fixes a bug ci Related to CI/CD enhancement New feature or request library Related to the static-web-server crate v2 v2 release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants