Skip to content

Commit f2b3778

Browse files
fredbifredbi
authored
doc: fixed typos and formatting issues in documentation. (#67)
* fixed README * re-aligned ROADMAP * fixed typos * relinted markdown & godoc (excl. generated) Signed-off-by: Frederic BIDON <[email protected]>
1 parent b66d608 commit f2b3778

File tree

9 files changed

+103
-30
lines changed

9 files changed

+103
-30
lines changed

‎.github/wordlist.txt‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1+
ADoc
12
API
23
APIs
4+
Acknowledgements
5+
Autocomplete
36
BDD
47
BSON
58
CI
@@ -9,13 +12,19 @@ CLIs
912
CSV
1013
CodeFactor
1114
CodeQL
15+
ComparisonOperators
1216
ContinueOnMethod
1317
DCO
18+
DSL
1419
DisableCapacities
1520
DisableMethods
1621
DisablePointerAddresses
1722
DisablePointerMethods
1823
DockerHub
24+
EDoc
25+
EType
26+
ElementsMatch's
27+
Enablement
1928
FAQ
2029
FDs
2130
GC
@@ -25,6 +34,7 @@ HTTP
2534
HTTPS
2635
HUGO
2736
ID
37+
IDE's
2838
IDs
2939
IOW
3040
IP
@@ -37,35 +47,64 @@ Kubernetes
3747
LOC
3848
Markdown
3949
MaxDepth
50+
Mezard
51+
NUnit
4052
NaN
4153
OAI
4254
OAuth
4355
Obershelp
4456
OpenAPI
57+
Orderable
58+
OrderedSlice
4559
PHPUnit
4660
PR
61+
PR's
4762
PRs
63+
PkgGoDev
64+
Pre
4865
PyTest
4966
README
67+
RSpec
5068
Ratcliff
5169
ReadDir
5270
Readlink
71+
Reimplemented
72+
Relinted
73+
SCSS
5374
SSN
75+
SUnit
76+
SeqContains
5477
SetSeq
78+
SignedNumber
79+
SliceSubset
5580
SortKeys
5681
SpewKeys
5782
Subpackages
83+
Substitutability
84+
Subtests
85+
Superlinear
5886
TCP
5987
TLS
6088
TODO
89+
TTY
90+
Teardown
91+
Triaging
6192
UI
6293
ULID
6394
URI
6495
URL
6596
URLs
6697
USD
6798
UUID
99+
Unmarshalers
100+
XYZ
68101
YAML
102+
- "dependending" - should be "depending"
103+
- "logics" - should be "logic" (uncountable noun)
104+
- "maintainance" - should be "maintenance"
105+
ad'hoc
106+
agentic
107+
allocs
69108
api
70109
apis
71110
arg
@@ -79,9 +118,11 @@ authenticators
79118
authorized
80119
authorizer
81120
authorizers
121+
autogenerate
82122
backquote
83123
backquoted
84124
bash
125+
benchmarked
85126
benchmarking
86127
bitmask
87128
bson
@@ -92,6 +133,7 @@ ci
92133
cidr
93134
cli
94135
clis
136+
cmp
95137
codebase
96138
codecov
97139
codegen
@@ -103,6 +145,7 @@ csv
103145
ctx
104146
customizable
105147
dependabot
148+
deps
106149
dereference
107150
dereferenced
108151
dereferencing
@@ -111,14 +154,18 @@ deserialize
111154
deserialized
112155
deserializer
113156
dev
157+
developercertificate
114158
difflib
159+
disambiguates
115160
docker
116161
dumpcgo
117162
e.g.
118163
env
119164
err's
165+
de facto
120166
faq
121167
fd
168+
fka
122169
flattener
123170
fmt
124171
fromfile
@@ -140,6 +187,7 @@ hostname
140187
hostnames
141188
html
142189
http
190+
httpOK
143191
https
144192
hugo
145193
i.e.
@@ -156,41 +204,54 @@ ipsums
156204
ipv4
157205
ipv6
158206
isbn
207+
iter
159208
json
160209
jsonschema
161210
k8s
162211
kubernetes
163212
lifecycle
164213
lineterm
165214
linter
215+
linter's
166216
linters
167217
listA
168218
listB
219+
logics
169220
loren
170221
lowercases
222+
maintainer's
171223
markdown
172224
marshaled
173225
marshaling
226+
matchers
227+
maths
228+
md
229+
metalinter
174230
middleware
175231
middlewares
176232
mixin
233+
mockFailNowT
234+
mockT
177235
monorepo
178236
multipart
179237
mutex
238+
ns
180239
oai
181240
oauth
182241
oauth2
183242
openapi
184243
param
185244
params
186245
pmezard
246+
pollCondition
187247
pprof
188248
prepend
189249
prepended
190250
readlines
191251
rebase
192252
rebased
193253
redeclare
254+
relinting
194255
repo
195256
repos
196257
roadmap
@@ -212,8 +273,11 @@ structs
212273
submodule
213274
subpackage
214275
substring
276+
subtests
277+
superlinearly
215278
swagger
216279
syncing
280+
testDataPath
217281
testcgo
218282
testify's
219283
testifylint
@@ -249,3 +313,4 @@ workspaces
249313
writelines
250314
xunit
251315
yaml
316+
ℹ

‎README.md‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,23 +46,28 @@ Design and exploration phase. Feedback, contributions and proposals are welcome.
4646
>
4747
> ✅ Fully refactored how assertions are generated and documented.
4848
>
49-
> ✅ Fixed hangs & panics when using `spew`. Fuzzed `spew`.
5049
>
51-
> ✅ Fixed go routine leaks with `EventuallyWithT` and co.
50+
> Fixes
5251
>
53-
> ✅ Added `Kind` & `NotKind`
52+
> ✅ Fixed hangs & panics when using `spew`. Fuzzed `spew`. Fixed deterministic order of keys in diff.
5453
>
55-
> ✅ Fix deterministic order of keys in diff
54+
> ✅ Fixed go routine leaks with `EventuallyWith` and co.
55+
>
56+
> ✅ Fixed wrong logic with `IsNonIncreasing`, `InNonDecreasing`
5657
>
5758
> ✅ Fixed edge cases with `InDelta`, `InEpsilon`
5859
>
5960
> ✅ Fixed edge cases with `EqualValues`
6061
>
61-
> ✅ Fixed wrong logic with `IsNonIncreasing`, `InNonDecreasing`
62+
> Additions
63+
>
64+
> ✅ Introduced generics: ~ 40 new type-safe assertions with generic types (doc: added usage guide, examples and benchmark)
65+
>
66+
> ✅ Added `Kind` & `NotKind`, `Consistently`, `NoGoRoutineLeak`, `NoFileDescriptorLeak`
6267
>
6368
> ✅ Added opt-in support for colorized output
6469
>
65-
> ✅ Introduced generics: 38 new type-safe assertions with generic types (doc: added usage guide, examples and benchmark)
70+
> ✅ Added migration tool
6671
>
6772
> See also our [ROADMAP][doc-roadmap].
6873

‎docs/doc-site/project/contributing/CONTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ Include documentation changes in the same commit so that a revert would remove a
248248
{{% tab title="Sign Your Work" %}}
249249
#### Sign your work
250250

251-
Software is developped by real people.
251+
Software is developed by real people.
252252

253253
The sign-off is a simple line at the end of your commit message,
254254
which certifies that you wrote it or otherwise have the right to

‎docs/doc-site/project/maintainers/ARCHITECTURE.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ weight: 2
88

99
### Goals
1010

11-
We want the maintainance of dozens of test assertions, times many variants, to remain reasonably low.
11+
We want the maintenance of dozens of test assertions, times many variants, to remain reasonably low.
1212

13-
The maintainance flow is intended to require different activities and levels of understanding,
13+
The maintenance flow is intended to require different activities and levels of understanding,
1414
dependending on the complexity of a planned evolution.
1515

1616
{{< mermaid align="center" zoom="true" >}}
@@ -51,7 +51,7 @@ one "forward" variant and one "forward formatted" variant (as methods).
5151
**For every "helper" function (not an assertion): 2 variants.**
5252

5353

54-
All these variants make up several hundreds functions, which poses a challenge for maintainance and documentation.
54+
All these variants make up several hundreds functions, which poses a challenge for maintenance and documentation.
5555

5656
We have adopted code and documentation generation as a mean to mitigate this issue.
5757

‎docs/doc-site/project/maintainers/BENCHMARKS.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ Collection operations see the most dramatic improvements due to elimination of p
4141
| **ElementsMatch (10 items)** | **21x faster** | 568 B → 320 B (44% reduction) | Common test operation |
4242
| **ElementsMatch (100 items)** | **39x faster** | 41 KB → 3.6 KB (91% reduction) | Scales superlinearly |
4343
| **ElementsMatch (1000 items)** | **81x faster** | 4 MB → 33 KB (99% reduction) | Large collection testing |
44-
| **SliceContains** | **16x faster** | 4 allocs → 0 | Membership testing |
45-
| **SeqContains (iter.Seq)** | **25x faster** | 55 allocs → 9 | Go 1.23+ iterators |
44+
| **SliceContainsT** | **16x faster** | 4 allocs → 0 | Membership testing |
45+
| **SeqContainsT (iter.Seq)** | **25x faster** | 55 allocs → 9 | Go 1.23+ iterators |
4646
| **SliceSubset** | **43x faster** | 17 allocs → 0 | Subset verification |
4747

4848
**Key insight**: ElementsMatch's O(n²) complexity amplifies the benefits—the speedup **increases** with collection size (21x → 39x → 81x).
@@ -78,8 +78,8 @@ Generic type checks eliminate reflection and provide a cleaner API:
7878

7979
| Function | Speedup | Notes |
8080
|----------|---------|-------|
81-
| **IsOfType** | **9-11x faster** | No dummy value needed with generics |
82-
| **IsNotOfType** | **Similar gains** | Type parameter makes intent explicit |
81+
| **IsOfTypeT** | **9-11x faster** | No dummy value needed with generics |
82+
| **IsNotOfTypeT** | **Similar gains** | Type parameter makes intent explicit |
8383

8484
### ⚖️ Modest Gains: Where Processing Dominates
8585

‎docs/doc-site/project/maintainers/MAINTAINERS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ This allows for minimal test dependencies.
8787
* all updates from "trusted" dependencies (github actions, golang.org packages, go-openapi packages
8888
are auto-merged if they successfully pass CI.
8989

90-
* go version udpates
90+
* go version updates
9191

9292
Principle:
9393

‎docs/doc-site/project/maintainers/ROADMAP.md‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,17 @@ timeline
2929
✅ v2.3 (Fev 2026) : Other extensions
3030
: Extensible Assertion type
3131
: JSON & YAML assertions: JSONMarshalsAs...
32-
: NoGoroutineLeak
32+
: NoGoRoutineLeak
3333
: more documentation and examples
3434
⏳v2.4 (Mar 2026) : Stabilize API (no more removals)
3535
: NoFileDescriptorLeak (unix)
36-
: async: Eventually/Never to accept error and context, Consistently
37-
: export internal tools (spew, difflib)
36+
: Eventually, Eventually (with context), Consistently
37+
: Migration tool
3838
section Q2 2026
39-
📝 v2.5 (May 2026) : New candidate features from upstream
40-
: NoFileDescriptorLeak (windows port)
41-
: export internal tools (blackbox)
39+
📝 v2.5 (May 2026) : synctest for Eventually/Consistently
40+
: NoFileDescriptorLeak (macOS, Windows)
41+
: New candidate features from upstream
42+
: export internal tools (spew, difflib)
4243
{{< /mermaid >}}
4344

4445
## Notes
@@ -50,7 +51,7 @@ timeline
5051
5. [x] More testing and bug fixes (from upstream or detected during our testing)
5152
6. [x] Introduces colorization (opt-in)
5253
7. [x] Introduces generics
53-
8. [x] Realign behavior re quirks, bugs, unexpected logics ... (e.g. IsNonDecreasing, EventuallyWithT...)
54+
8. [x] Realign behavior re quirks, bugs, unexpected logics ... (e.g. `IsNonDecreasing`, `EventuallyWithT`...)
5455
10. [x] Unclear assertions might be provided an alternative verb (e.g. `EventuallyWithT`)
5556

5657
### Adoption timeline at go-openapi
@@ -61,7 +62,7 @@ timeline
6162

6263
### What won't come anytime soon
6364

64-
* mocks: we use [mockery](https://https://github.com/vektra/mockery) and prefer the simpler `matryer` mocking-style.
65+
* mocks: we use [mockery](https://github.com/vektra/mockery) and prefer the simpler `matryer` mocking-style.
6566
testify-style mocks are thus not going to be supported anytime soon.
6667
* extra convoluted stuff in the like of `InDeltaSlice` (more likely to be removed)
6768

0 commit comments

Comments
 (0)