docs: update formatting for godocs (#78)

twilio · May 11, 2021 · 5b98eca · 5b98eca
1 parent d731c40
commit 5b98eca
Show file tree

Hide file tree

Showing 36 changed files with 6,292 additions and 17,185 deletions.
diff --git a/README.md b/README.md
@@ -351,5 +351,22 @@ To execute the test suite run:
 go test ./...
 ```
 
+### Generating Local Documentation
+
+To generate documentation, from the root directory:
+
+```bash
+godoc -http=localhost:{port number}
+```
+
+Then, navigate to `http://localhost:{port number}/pkg/github.com/twilio/twilio-go` in your local browser.
+
+Example:
+
+```bash
+godoc -http=localhost:6060
+```
+http://localhost:6060/pkg/github.com/twilio/twilio-go
+
 [apidocs]: https://www.twilio.com/docs/api
 [libdocs]: https://pkg.go.dev/github.com/twilio/twilio-go?tab=versions
diff --git a/go.mod b/go.mod
@@ -9,5 +9,5 @@ require (
 	github.com/pkg/errors v0.9.1
 	github.com/shirou/gopsutil v0.0.0-20190901111213-e4ec7b275ada // indirect
 	github.com/stretchr/testify v1.7.0
-	golang.org/x/tools v0.1.0 // indirect
+	golang.org/x/tools v0.1.1 // indirect
 )
diff --git a/go.sum b/go.sum
diff --git a/rest/accounts/v1/api_default.go b/rest/accounts/v1/api_default.go