Skip to content

Commit 9b92774

Browse files
authored
doc: polished godoc (#65)
Applied custom godoc linter & spellcheck to fix all godoc comments. Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
1 parent 56b5954 commit 9b92774

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+978
-928
lines changed

.github/wordlist.txt

Lines changed: 48 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,27 @@ CI
66
CIDR
77
CLI
88
CLIs
9+
CSV
910
CodeFactor
1011
CodeQL
11-
CSV
12+
ContinueOnMethod
1213
DCO
14+
DisableCapacities
15+
DisableMethods
16+
DisablePointerAddresses
17+
DisablePointerMethods
1318
DockerHub
1419
FAQ
20+
FDs
1521
GC
1622
GOPATH
1723
GOROOT
18-
GoDoc
19-
Godoc
2024
HTTP
2125
HTTPS
2226
HUGO
2327
ID
2428
IDs
29+
IOW
2530
IP
2631
IPs
2732
ISBN
@@ -31,16 +36,25 @@ JUnit
3136
Kubernetes
3237
LOC
3338
Markdown
39+
MaxDepth
3440
NaN
3541
OAI
3642
OAuth
43+
Obershelp
3744
OpenAPI
3845
PHPUnit
3946
PR
4047
PRs
4148
PyTest
4249
README
50+
Ratcliff
51+
ReadDir
52+
Readlink
4353
SSN
54+
SetSeq
55+
SortKeys
56+
SpewKeys
57+
Subpackages
4458
TCP
4559
TLS
4660
TODO
@@ -57,6 +71,7 @@ apis
5771
arg
5872
args
5973
assignees
74+
async
6075
auth
6176
authenticated
6277
authenticator
@@ -85,19 +100,29 @@ colorizers
85100
config
86101
configs
87102
csv
103+
ctx
88104
customizable
89105
dependabot
90106
dereference
107+
dereferenced
91108
dereferencing
109+
deserialization
92110
deserialize
93111
deserialized
94112
deserializer
113+
dev
114+
difflib
95115
docker
116+
dumpcgo
96117
e.g.
97118
env
98119
err's
99120
faq
121+
fd
100122
flattener
123+
fmt
124+
fromfile
125+
fromfiledate
101126
fuzzying
102127
gc
103128
github
@@ -109,6 +134,8 @@ golangci
109134
golint
110135
goroutine
111136
goroutines
137+
grpc
138+
hexdump
112139
hostname
113140
hostnames
114141
html
@@ -122,6 +149,7 @@ implementor
122149
implementors
123150
initialism
124151
initialisms
152+
inodes
125153
io
126154
ipsum
127155
ipsums
@@ -133,6 +161,7 @@ jsonschema
133161
k8s
134162
kubernetes
135163
lifecycle
164+
lineterm
136165
linter
137166
linters
138167
listA
@@ -154,14 +183,17 @@ oauth2
154183
openapi
155184
param
156185
params
186+
pmezard
187+
pprof
157188
prepend
158189
prepended
190+
readlines
159191
rebase
160192
rebased
161-
roadmap
162193
redeclare
163194
repo
164195
repos
196+
roadmap
165197
roundtrip
166198
roundtripper
167199
schema
@@ -174,22 +206,31 @@ sexualized
174206
spdx
175207
ssn
176208
stdlib
209+
stretchr
177210
struct
178211
structs
179212
submodule
180213
subpackage
181214
substring
182215
swagger
216+
syncing
217+
testcgo
183218
testify's
219+
testifylint
184220
tls
221+
tm
222+
tofile
223+
tofiledate
185224
toolchain
186225
ui
187226
ulid
188227
uncategorized
228+
unexported
229+
unidiff
189230
unmarshal
190231
unmarshaled
232+
unmarshaler
191233
unmarshaling
192-
unexported
193234
untyped
194235
uri
195236
url
@@ -202,7 +243,9 @@ v3
202243
validator
203244
validators
204245
waitFor
246+
windiff
205247
workspace
206248
workspaces
249+
writelines
207250
xunit
208251
yaml

assert/assert_assertions.go

Lines changed: 19 additions & 19 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)