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.

Sign up for GitHub

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

Jump to bottom

unsafe: no documentation for unsafe.SliceData, StringData, or String #54858

Closed
robpike opened this issue Sep 4, 2022 · 5 comments
Closed

unsafe: no documentation for unsafe.SliceData, StringData, or String #54858

robpike opened this issue Sep 4, 2022 · 5 comments
Assignees
@mdempsky @griesemer
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. release-blocker
Milestone
Go1.20

Comments

@robpike
Copy link
Contributor

robpike commented Sep 4, 2022

Recent changes added these data types to the unsafe package, but due to the peculiarities of how unsafe is implemented, special work needs to be done to have

go doc unsafe.String

work. It does not:

% go doc unsafe.String
doc: no symbol String in package unsafe
exit status 1
%

Please fix.
@robpike robpike added Documentation Issues describing a change to documentation. release-blocker labels Sep 4, 2022
@hopehook
Copy link
Member

hopehook commented Sep 4, 2022

Final work is in progress, there are still some comments on the revisions to the documentation that have not been resolved, so they have not been merged.

FYI: https://go-review.googlesource.com/c/go/+/427095

@hopehook hopehook added the NeedsFix The path to resolution is known, but the work has not been done. label Sep 4, 2022
@hopehook
Copy link
Member

hopehook commented Sep 4, 2022

CC @mdempsky

@robpike robpike closed this as completed Sep 4, 2022
@griesemer
Copy link
Contributor

Not sure why this was closed. As far as I can tell, this is not done yet.

@griesemer griesemer reopened this Sep 26, 2022
@griesemer griesemer mentioned this issue Sep 26, 2022
Closed
@robpike
Copy link
Contributor Author

robpike commented Sep 27, 2022

Closed because it overlapped with other issues about this, and because of https://go-review.googlesource.com/c/go/+/427095

@griesemer
Copy link
Contributor

https://go-review.googlesource.com/c/go/+/427095 is now submitted. The spec changes have also been submitted (https://go-review.googlesource.com/c/go/+/449537).

@golang golang locked and limited conversation to collaborators Nov 15, 2023
@dmitshur dmitshur added this to the Go1.20 milestone Sep 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@mdempsky mdempsky

@griesemer griesemer

Labels
Documentation Issues describing a change to documentation. FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. release-blocker
Projects
None yet
Milestone
Go1.20
Development

No branches or pull requests
6 participants
@mdempsky @dmitshur @robpike @hopehook @griesemer @gopherbot