WIP: deprecation support #255
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dlowe
commented
Apr 30, 2025
| lang: Language, | ||
| docs: &'_ [&'_ str], | ||
| // an Option<&str> passed as an empty or exactly-one-element slice... is there a better way? | ||
| deprecated: &'_ [&'static str], |
Author
There was a problem hiding this comment.
@danielhenrymantilla I don't love this, any better ideas?
dlowe
commented
Apr 30, 2025
| abort_on_unwind_guard = #ඞ::UnwindGuard(#export_name_str), | ||
| unsafe { | ||
| #layout::into_raw( | ||
| #[allow(deprecated)] |
Author
There was a problem hiding this comment.
we could make this allow conditional on the function actually being deprecated, I suppose? It doesn't seem worth the effort, but I could be persuaded.
dlowe
commented
Apr 30, 2025
| mk_out!(indent, ctx.out()); | ||
|
|
||
| if docs.is_empty() { | ||
| if docs.is_empty() && deprecated.is_none() { |
Author
There was a problem hiding this comment.
this isn't exactly right, but I think getting it exactly right requires a bit of a deeper refactor.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WIP for early feedback.
known TODOs assuming I'm on the right track:
#[deprecated]annotation to the generated (rust) shim function? This probably doesn't really accomplish anything, since it covers calling the shim function from rust code, which is already very weird, I think?#[deprecated]attribute on non-fnelements#[deprecated(note = "foo")]attribute syntaxdeprecatedtagged docstringObsoleteAttributeannotations