[Bug Report] Crate not Documentable with Rust 1.69.0 #624
Comments
sunfishcode
added a commit
that referenced
this issue
Apr 23, 2023
Remove a doc comment which is redundant because it's on a re-export of an item which already has its own doc comment. This also happens to work around a bug in at least Rust 1.69. Fixes #624.
|
Thanks for the report! This turns out to be triggered by a doc comment which is redundant anyway, so I filed #627 to the 0.36 release branch removing the comment, which avoids the cargo doc abort. It's already removed on main and 0.37. |
sunfishcode
added a commit
that referenced
this issue
Apr 23, 2023
* Remove an unneeded doc, fixing the doc build on stable Rust. Remove a doc comment which is redundant because it's on a re-export of an item which already has its own doc comment. This also happens to work around a bug in at least Rust 1.69. Fixes #624. * In the Rust 1.48 CI, pin tempfile to 3.4.0. tempfile 3.5.0 depends on rustix 0.37. Pin to tempfile 3.4.0 since it uses rustix 0.36 as this is the rustix 0.36 branch. * Temporarily disable tests on Windows. * Disable `test_backends` on Rust 1.48. * Disable FreeBSD CI for now. (#530) (#600) FreeBSD CI is currently broken with this error ``` [4/4] Extracting curl-7.88.1: .......... done curl https://sh.rustup.rs -sSf --output rustup.sh ld-elf.so.1: /usr/local/lib/libcurl.so.4: Undefined symbol "nghttp2_option_set_no_rfc9113_leading_and_trailing_ws_validation" ``` From some quick searches I found [this bug] which looks related, but I didn't see anything in the discussion which would let us work around the problem. [this bug]: https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=269253
|
This is now fixed in 0.36.13. |
|
Thank you very much for your support! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
With the latest available stable Rust version, 1.69.0, it is not possible anymore to document this crate. The compiler panics and exits due a documentation link not being resolvable.
I realise that this behaviour is first of all a critical compiler error of
rustcbut during my tests, every project with this crate, v0.36.4 or later, as dependency was not documentable. Thus, I assumed that you should probably know about this issue, as well.The text was updated successfully, but these errors were encountered: