forked from sagebind/stability
-
Notifications
You must be signed in to change notification settings - Fork 0
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
Add stable
macro
#10
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I was implementing a new feature in Ratatui and was going to write a manual doc comment about when it was introduced, but it struck me that the way that this is is handled in the Rust Standard Lib is with a macro named stable. E.g.:
#![stable(feature = "alloc_module", since = "1.28.0")]
Produces https://doc.rust-lang.org/nightly/alloc/alloc/index.html
While I don't think we can hook into the rustdoc rendering to make this actually spit the version info in the top right corner, we can probably add some small amount of html to the bottom of the item's docs that states the version number that something was introduced in.
Recently there have been conversations with newer Ratatui users that don't have the context of when new things were added. This would be a helpful tool to make this part of the standard way that we document new functionality (and would save having to look for changelogs etc. to find out when something was implemented).
The text was updated successfully, but these errors were encountered: