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.

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

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
Labels
Documentation NeedsFix The path to resolution is known, but the work has not been done. release-blocker

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.

@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

griesemer commented Sep 26, 2022

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

@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

griesemer commented Nov 15, 2022

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation NeedsFix The path to resolution is known, but the work has not been done. release-blocker
Projects
None yet
Development

No branches or pull requests

4 participants