Crates.io/docs.rs claim a package has no README/documentation

This is strange. I chanced upon the following package:

https://crates.io/crates/alloc_counter

Crates.io claims it has no README.md though the repo and the docs.rs source view[1] both show it does. Moreover, docs.rs in turn claims that

alloc_counter-0.0.4 doesn't have any documentation.

and only shows its own (little-known) crate page which does display the README without problems. However, the lib.rs does have doc comments.[2]

Oh, and Discourse said about the crates.io link:

Sorry, we were unable to generate a preview for this web page, because the web server returned an error code of 404. Instead of a preview, only a link will appear in your post. :cry:

which is also interesting.


  1. Distinct from the source view you get by clicking on "source" in the API docs. Yes, docs.rs has two different source views. ↩︎

  2. Though its module-level doc seems to be gated behind a non-default rustdoc feature :face_with_raised_eyebrow: ↩︎

I see that the most recent docs build failed: https://docs.rs/crate/alloc_counter/0.0.4/builds/1515768. So, docs.rs is working off very old build results. That might account for some weirdness on docs.rs's side.

3 Likes