Skip to content

Do not document reexports#33

Merged
joshka merged 1 commit intoratatui:mainfrom
bugadani:reexport
Feb 19, 2026
Merged

Do not document reexports#33
joshka merged 1 commit intoratatui:mainfrom
bugadani:reexport

Conversation

@bugadani
Copy link
Copy Markdown
Contributor

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

Copilot AI review requested due to automatic review settings December 15, 2025 16:01
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Dec 15, 2025

Codecov Report

❌ Patch coverage is 83.33333% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 84.00%. Comparing base (8b311cd) to head (ee8927d).

Files with missing lines Patch % Lines
src/unstable.rs 83.33% 2 Missing ⚠️
src/stable.rs 83.33% 1 Missing ⚠️
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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@joshka
Copy link
Copy Markdown
Member

joshka commented Jan 1, 2026

Seems like a reasonably simple fix. Can you confirm that it fixes the upstream bugs you've mentioned in esp-hal?

@bugadani
Copy link
Copy Markdown
Contributor Author

bugadani commented Jan 2, 2026

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"?

@bugadani
Copy link
Copy Markdown
Contributor Author

bugadani commented Jan 5, 2026

I can confirm that this PR solves our issue where reexported items' documentation summary only says "Stability".

@MabezDev
Copy link
Copy Markdown

MabezDev commented Feb 5, 2026

Any movement here? We'd love for this to land :).

@orhun orhun requested a review from joshka February 5, 2026 15:34
@MabezDev
Copy link
Copy Markdown

Gentle ping :)

@joshka joshka merged commit 7087692 into ratatui:main Feb 19, 2026
10 of 11 checks passed
@github-actions github-actions Bot mentioned this pull request Feb 19, 2026
@bugadani bugadani deleted the reexport branch February 19, 2026 22:15
joshka pushed a commit that referenced this pull request Mar 16, 2026
## 🤖 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Unstable "use" does not interoperate well with documentation of underlying types

5 participants