Skip to content

Commit 8666e31

Browse files
committed
Cleanup docs further
1 parent 727dd54 commit 8666e31

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ go get nhooyr.io/websocket
3131

3232
## Examples
3333

34-
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).
34+
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).
3535

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

docs/CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ to an existing issue if one exists. In general, create an issue before a PR to g
2424
discussion going and to make sure you do not spend time on a PR that may be rejected.
2525

2626
The Go module where development occurs is in the [mod](../mod) subpath so that the README.md
27-
is immediately visible on the main page.
27+
is immediately visible on the main page. I regularly clone the repo with mod as the root
28+
to [nhooyr/websocket-mod](https://github.com/nhooyr/websocket-mod) so that all tooling works
29+
normally.
2830

2931
CI must pass on your changes for them to be merged.
3032

0 commit comments

Comments
 (0)