Skip to content

Commit 126a469

Browse files
fredbifredbi
authored
doc: fixed a few typos in godoc comments (#59)
doc site: fixed clickable link to go playground for testable examples. Signed-off-by: Frederic BIDON <[email protected]>
1 parent 6db737e commit 126a469

File tree

23 files changed

+689
-506
lines changed

23 files changed

+689
-506
lines changed

‎.github/wordlist.txt‎

Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
1+
API
2+
APIs
3+
BSON
4+
CI
5+
CIDR
6+
CLI
7+
CLIs
8+
CSV
9+
DCO
10+
DockerHub
11+
FAQ
12+
GC
13+
GOPATH
14+
GOROOT
15+
GoDoc
16+
Godoc
17+
HTTP
18+
HTTPS
19+
HUGO
20+
ID
21+
IDs
22+
IP
23+
IPs
24+
ISBN
25+
JSON
26+
Kubernetes
27+
Markdown
28+
NaN
29+
OAI
30+
OAuth
31+
OpenAPI
32+
PR
33+
PRs
34+
README
35+
SSN
36+
TCP
37+
TLS
38+
TODO
39+
UI
40+
ULID
41+
URI
42+
URL
43+
URLs
44+
USD
45+
UUID
46+
YAML
47+
api
48+
apis
49+
arg
50+
args
51+
assignees
52+
auth
53+
authenticated
54+
authenticator
55+
authenticators
56+
authorized
57+
authorizer
58+
authorizers
59+
backquote
60+
backquoted
61+
bash
62+
benchmarking
63+
bitmask
64+
bson
65+
bytesize
66+
cancelled
67+
ci
68+
cidr
69+
cli
70+
clis
71+
codecov
72+
codegen
73+
config
74+
configs
75+
csv
76+
customizable
77+
dependabot
78+
deserialize
79+
deserialized
80+
deserializer
81+
docker
82+
e.g.
83+
env
84+
err's
85+
faq
86+
flattener
87+
fuzzying
88+
gc
89+
github
90+
go-openapi
91+
godoc
92+
golang
93+
golangci
94+
golint
95+
goroutine
96+
goroutines
97+
hostname
98+
hostnames
99+
html
100+
http
101+
https
102+
hugo
103+
i.e.
104+
id
105+
implementor
106+
implementors
107+
initialism
108+
initialisms
109+
io
110+
ipsum
111+
ipsums
112+
ipv4
113+
ipv6
114+
isbn
115+
json
116+
jsonschema
117+
k8s
118+
kubernetes
119+
linter
120+
linters
121+
listA
122+
listB
123+
loren
124+
lowercases
125+
markdown
126+
marshaled
127+
marshaling
128+
middleware
129+
middlewares
130+
mixin
131+
multipart
132+
mutex
133+
oai
134+
oauth
135+
oauth2
136+
openapi
137+
param
138+
params
139+
rebase
140+
rebased
141+
redeclare
142+
repo
143+
repos
144+
roundtrip
145+
roundtripper
146+
schema
147+
schemas
148+
serialize
149+
serialized
150+
serializer
151+
sexualized
152+
ssn
153+
struct
154+
structs
155+
submodule
156+
subpackage
157+
substring
158+
swagger
159+
tls
160+
toolchain
161+
ui
162+
ulid
163+
unmarshal
164+
unmarshaled
165+
unmarshaling
166+
untyped
167+
uri
168+
url
169+
urls
170+
utf-8
171+
uuid
172+
v1
173+
v2
174+
v3
175+
validator
176+
validators
177+
waitFor
178+
workspace
179+
workspaces
180+
yaml

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,6 @@ vendor
33
Godeps
44
.idea
55
*.out
6+
.mcp.json
7+
.claude/**.md
8+
!.claude/CLAUDE.md

‎assert/assert_assertions.go‎

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

‎codegen/internal/generator/funcmaps/markdown.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -252,9 +252,9 @@ func addExamples(trailer []string, funcName string, perPkgExamples []packageExam
252252
trailer = append(trailer, `{{% cards %}}`)
253253

254254
for _, example := range pe.examples {
255-
trailer = append(trailer, `{{% card href="https://go.dev/play/" %}}`)
255+
trailer = append(trailer, `{{% card %}}`)
256256
trailer = append(trailer, "\n")
257-
trailer = append(trailer, `*Copy and click to open Go Playground*`)
257+
trailer = append(trailer, `*[Copy and click to open Go Playground](https://go.dev/play/)*`)
258258
trailer = append(trailer, "\n")
259259
trailer = append(trailer, "```go")
260260
trailer = append(trailer, fmt.Sprintf("// real-world test would inject *testing.T from Test%s(t *testing.T)", funcName))

‎docs/doc-site/api/boolean.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,10 @@ False asserts that the specified value is false.
4848
{{< /tab >}}
4949
{{% tab title="Testable Examples (assert)" %}}
5050
{{% cards %}}
51-
{{% card href="https://go.dev/play/" %}}
51+
{{% card %}}
5252

5353

54-
*Copy and click to open Go Playground*
54+
*[Copy and click to open Go Playground](https://go.dev/play/)*
5555

5656

5757
```go
@@ -82,10 +82,10 @@ func main() {
8282

8383
{{% tab title="Testable Examples (require)" %}}
8484
{{% cards %}}
85-
{{% card href="https://go.dev/play/" %}}
85+
{{% card %}}
8686

8787

88-
*Copy and click to open Go Playground*
88+
*[Copy and click to open Go Playground](https://go.dev/play/)*
8989

9090

9191
```go
@@ -163,10 +163,10 @@ The type constraint [Boolean](https://pkg.go.dev/github.com/go-openapi/testify/v
163163
{{< /tab >}}
164164
{{% tab title="Testable Examples (assert)" %}}
165165
{{% cards %}}
166-
{{% card href="https://go.dev/play/" %}}
166+
{{% card %}}
167167

168168

169-
*Copy and click to open Go Playground*
169+
*[Copy and click to open Go Playground](https://go.dev/play/)*
170170

171171

172172
```go
@@ -197,10 +197,10 @@ func main() {
197197

198198
{{% tab title="Testable Examples (require)" %}}
199199
{{% cards %}}
200-
{{% card href="https://go.dev/play/" %}}
200+
{{% card %}}
201201

202202

203-
*Copy and click to open Go Playground*
203+
*[Copy and click to open Go Playground](https://go.dev/play/)*
204204

205205

206206
```go
@@ -270,10 +270,10 @@ True asserts that the specified value is true.
270270
{{< /tab >}}
271271
{{% tab title="Testable Examples (assert)" %}}
272272
{{% cards %}}
273-
{{% card href="https://go.dev/play/" %}}
273+
{{% card %}}
274274

275275

276-
*Copy and click to open Go Playground*
276+
*[Copy and click to open Go Playground](https://go.dev/play/)*
277277

278278

279279
```go
@@ -304,10 +304,10 @@ func main() {
304304

305305
{{% tab title="Testable Examples (require)" %}}
306306
{{% cards %}}
307-
{{% card href="https://go.dev/play/" %}}
307+
{{% card %}}
308308

309309

310-
*Copy and click to open Go Playground*
310+
*[Copy and click to open Go Playground](https://go.dev/play/)*
311311

312312

313313
```go
@@ -385,10 +385,10 @@ The type constraint [Boolean](https://pkg.go.dev/github.com/go-openapi/testify/v
385385
{{< /tab >}}
386386
{{% tab title="Testable Examples (assert)" %}}
387387
{{% cards %}}
388-
{{% card href="https://go.dev/play/" %}}
388+
{{% card %}}
389389

390390

391-
*Copy and click to open Go Playground*
391+
*[Copy and click to open Go Playground](https://go.dev/play/)*
392392

393393

394394
```go
@@ -419,10 +419,10 @@ func main() {
419419

420420
{{% tab title="Testable Examples (require)" %}}
421421
{{% cards %}}
422-
{{% card href="https://go.dev/play/" %}}
422+
{{% card %}}
423423

424424

425-
*Copy and click to open Go Playground*
425+
*[Copy and click to open Go Playground](https://go.dev/play/)*
426426

427427

428428
```go

0 commit comments

Comments
 (0)