-
Notifications
You must be signed in to change notification settings - Fork 10.5k
[stdlib] NFC: Restore doc comment for Unsafe[Mutable]BufferPointer #63288
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
Conversation
…Pointer Moves a `//` comment up above a `///` documentation comment, since the latter needs to be attached directly to the declaration or it won't be picked up as documentation.
@swift-ci please smoke test |
I think the comment should just be removed. Library Evolution in Swift:
(Likewise, all the |
I’m fine with that approach too, Ben. My goal here is just to bring the documentation back; hopefully someone more familiar with the status of the FIXME can comment on whether it’s best to move or remove the comment. Edit: Updated the PR for that approach; can revert if someone wants to keep the comment. |
Per Ben's feedback in the PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree that we can remove this FIXME
. ABI stability makes the change suggested here untenable, therefore removing it is the right thing to do.
@swift-ci please smoke test and merge |
1 similar comment
@swift-ci please smoke test and merge |
@krilnon Could you also make a PR with this change cherry-picked to the |
[stdlib] NFC: Restore doc comment for Unsafe[Mutable]BufferPointer (cherry picked from commit 124b098)
LGTM – thanks |
Moves a
//
comment up above a///
documentation comment, since the latter needs to be attached directly to the declaration or it won't be picked up as documentation.