Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
sandersaares opened this issue Aug 9, 2024 · 1 comment

Comments

@sandersaares
Copy link

sandersaares commented Aug 9, 2024

When a re-export "use" statement is marked as unstable, the availability chapter seems to get just prepended to the original docs without any proper formatting to separate it from the original body. This seems suboptimal from a readability perspective - I would expect it not to "take over" the documentation like that:

image

I am guessing this is just how doc attributes on re-exports are handled - prefix the original with it? But at least some improvements seem possible here:

  • Do not start with an "Availability" chapter - the original text in there is not about availability.
  • Start a new paragraph after the availability warning, so there is a clear distinction between availability warning and type documentation.
@joshka
Copy link
Member

joshka commented Nov 11, 2024

Hey, I just noticed this issue. Sorry for no response. For some reason I never got a notification from GitHub.

This definitely feels sub-optimal. Perhaps you could experiment with some code to find a good way of displaying this info for re-exports and we can work backwards from that to something that works better to incorporate into the macro.

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

No branches or pull requests

2 participants