-
Notifications
You must be signed in to change notification settings - Fork 53
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
doc: incorporate Go reference document changes for Alpha release #41
Conversation
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.
Reviewed against the doc from Hilary and identified a bunch of formatting things that were not implemented. Nothing is critical but I flagged as many as I could. Happy to review again once those changes are in and confirm that nothing else is amiss.
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.
Thanks @maddyhof , these are all Godoc specific formats, and there are some restrictions: for example, only type names can be wrapped by []
but not method names. Also typically we don't wrap a type with []
in the documentation that describes the type itself (example, the Closer
is not wrapped in []
in io.Closer
). Similarly, we won't add backticks "`" to most of the names, unless it is a local function parameter.
As discussed, feel free to ignore my comments that don't make sense in the Go style, and reject Hilary's suggestions in the doc so that we know which things aren't going to be implemented. |
No description provided.