good morning!!!!

Skip to content
Snippets Groups Projects
Unverified Commit 8666e31b authored by Anmol Sethi's avatar Anmol Sethi
Browse files

Cleanup docs further

parent 727dd542
No related branches found
No related tags found
No related merge requests found
......@@ -31,7 +31,7 @@ go get nhooyr.io/websocket
## Examples
For a production quality example that shows off the full API, see the [echo example on the godoc](https://godoc.org/nhooyr.io/websocket#example-package--Echo). On github, the example is at [./mod/example_echo_test.go](./mod/example_echo_test.go).
For a production quality example that shows off the full API, see the [echo example on the godoc](https://godoc.org/nhooyr.io/websocket#example-package--Echo). On github, the example is at [mod/example_echo_test.go](./mod/example_echo_test.go).
Please use the [errors.As](https://golang.org/pkg/errors/#As) function [new in Go 1.13](https://golang.org/doc/go1.13#error_wrapping) to check for [websocket.CloseError](https://godoc.org/nhooyr.io/websocket#CloseError). See the [CloseError godoc example](https://godoc.org/nhooyr.io/websocket#example-CloseError).
......
......@@ -24,7 +24,9 @@ to an existing issue if one exists. In general, create an issue before a PR to g
discussion going and to make sure you do not spend time on a PR that may be rejected.
The Go module where development occurs is in the [mod](../mod) subpath so that the README.md
is immediately visible on the main page.
is immediately visible on the main page. I regularly clone the repo with mod as the root
to [nhooyr/websocket-mod](https://github.com/nhooyr/websocket-mod) so that all tooling works
normally.
CI must pass on your changes for them to be merged.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment