Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #33 +/- ##
==========================================
+ Coverage 83.74% 84.00% +0.25%
==========================================
Files 4 4
Lines 363 375 +12
==========================================
+ Hits 304 315 +11
- Misses 59 60 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Seems like a reasonably simple fix. Can you confirm that it fixes the upstream bugs you've mentioned in esp-hal? |
|
We stopped using instability on reexports because of this issue, but I will double-check if this is a solution. Just to be extra sure, are you okay with the implication that it is no longer possible to mark something as "unstable reexport of stable item"? |
|
I can confirm that this PR solves our issue where reexported items' documentation summary only says "Stability". |
|
Any movement here? We'd love for this to land :). |
|
Gentle ping :) |
## 🤖 New release * `instability`: 0.3.11 -> 0.3.12 * `instability-example`: 0.3.11 -> 0.3.12 <details><summary><i><b>Changelog</b></i></summary><p> ## `instability` <blockquote> ## [0.3.12](instability-v0.3.11...instability-v0.3.12) - 2026-02-19 ### Other - Do not document reexports ([#33](#33)) </blockquote> ## `instability-example` <blockquote> ## [0.3.7](instability-example-v0.3.6...instability-example-v0.3.7) - 2025-01-10 ### Other - Add #[allow(unused_imports)] lint to unstable reexports ([#21](#21)) </blockquote> </p></details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
There are a few problems with adding documentation to
pub use:I propose simply not adding doc attributes to reexports. If the item is unstable, the item itself should also be marked with
#[unstable]. If a stable item is reexported with an unstable reexport, rustdoc will still display the required feature flag on the short documentation.Closes #11