Skip to content

[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

Merged
merged 2 commits into from
Feb 1, 2023

Conversation

krilnon
Copy link
Member

@krilnon krilnon commented Jan 28, 2023

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.

…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.
@krilnon
Copy link
Member Author

krilnon commented Jan 28, 2023

@swift-ci please smoke test

@benrimmington
Copy link
Contributor

I think the comment should just be removed. Library Evolution in Swift:

Adding or removing the @frozen attribute on a struct or enum is not allowed.

(Likewise, all the FIXME(ABI) comments?)

@krilnon
Copy link
Member Author

krilnon commented Jan 29, 2023

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.
Copy link
Contributor

@glessard glessard left a 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.

@glessard
Copy link
Contributor

@swift-ci please smoke test and merge

1 similar comment
@krilnon
Copy link
Member Author

krilnon commented Feb 1, 2023

@swift-ci please smoke test and merge

@swift-ci swift-ci merged commit 124b098 into main Feb 1, 2023
@swift-ci swift-ci deleted the krilnon/unsafe-buffer-pointer-docs branch February 1, 2023 07:04
@glessard
Copy link
Contributor

glessard commented Feb 1, 2023

@krilnon Could you also make a PR with this change cherry-picked to the release/5.8 branch? It seems a worthwhile change to include from the documentation angle. We'll see if a branch manager agrees.

krilnon pushed a commit that referenced this pull request Feb 2, 2023
[stdlib] NFC: Restore doc comment for Unsafe[Mutable]BufferPointer

(cherry picked from commit 124b098)
@krilnon
Copy link
Member Author

krilnon commented Feb 2, 2023

@glessard Made one in #63362; let me know if anything looks off about the structure/reviewers, etc. Haven't done the release cherry-pick thing before.

@glessard
Copy link
Contributor

glessard commented Feb 2, 2023

LGTM – thanks

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.

4 participants