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

doc: incorporate Go reference document changes for Alpha release #41

Merged
merged 10 commits into from
Aug 17, 2023

Conversation

jyyi1
Copy link
Contributor

@jyyi1 jyyi1 commented Aug 10, 2023

No description provided.

@jyyi1 jyyi1 requested review from fortuna and maddyhof August 10, 2023 20:14
network/delegate_packet_proxy.go Outdated Show resolved Hide resolved
@fortuna fortuna self-requested a review August 11, 2023 22:54
network/doc.go Outdated Show resolved Hide resolved
transport/packet.go Outdated Show resolved Hide resolved
Copy link
Contributor

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

Copy link
Contributor Author

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

network/delegate_packet_proxy.go Show resolved Hide resolved
network/doc.go Outdated Show resolved Hide resolved
network/packet_proxy.go Show resolved Hide resolved
transport/packet.go Outdated Show resolved Hide resolved
transport/packet.go Show resolved Hide resolved
transport/stream.go Show resolved Hide resolved
transport/stream.go Show resolved Hide resolved
transport/stream.go Show resolved Hide resolved
transport/stream.go Show resolved Hide resolved
transport/stream.go Show resolved Hide resolved
@maddyhof
Copy link
Contributor

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.

@jyyi1 jyyi1 merged commit 484adab into main Aug 17, 2023
6 checks passed
@jyyi1 jyyi1 deleted the junyi/go-doc-update branch August 17, 2023 23:40
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.

3 participants