Make great documentation goal 1.2, and renumber goals 13 to 16 as 12 to 15 wherever they are cited
Tests / vet + fmt + tests (pull_request) Has been cancelled
Tests / Known vulnerabilities in this Go version and the required modules (pull_request) Has been cancelled
Tests / Release from CHANGELOG.md (pull_request) Has been cancelled
Tests / packages (pull_request) Has been cancelled

This commit is contained in:
2026-10-14 22:55:20 +02:00
parent 79dafa38f0
commit c400ed7908
5 changed files with 67 additions and 67 deletions
+9 -9
View File
@@ -417,9 +417,9 @@ carry sub-fields — `misc.currency.symbol`, `misc.territory.alpha2`,
Where a script under [`data-import/`](data-import) reads a source, the facts come from
that source, and the script drops a row only by a rule it states; elsewhere a small hand-written
set ships, and [`todo.md`](todo.md) carries the step that replaces it (goal 14). Copy
set ships, and [`todo.md`](todo.md) carries the step that replaces it (goal 13). Copy
that states no fact, such as `word` and `sentence`, stays hand-written. Where a category
has no path that draws only values reaching nothing real (goal 16), write a fixed value such
has no path that draws only values reaching nothing real (goal 15), write a fixed value such
as `example.com` into the template; `todo.md` plans the path.
`misc.httpmethod`, `misc.protocol` and `misc.port` are IANA's registries.
@@ -980,7 +980,7 @@ advertises no such path; read that level whole.
### Performance
The target is about a microsecond per value (goal 13).
The target is about a microsecond per value (goal 12).
A source with an [index](#data), as the shipped set has, loads nothing in `New`: a
category loads on the first `Fake`, `FakeRecord`, `FakeStruct` or template that reads
@@ -1053,6 +1053,7 @@ Where the project is heading; the sections before Audience document what ships t
1. **The best fake-data tool there is, and the one developers reach for.**
1. You can install it the way you install your other tools, and people hear about
it where developers read.
2. **Great documentation.**
2. **Enough data ships built in to fill a real test database: the CLI carries all of it, a
library imports what it needs, and nothing is fetched at run time.**
1. Each locale covers the common categories: names, addresses, phone numbers, ids,
@@ -1117,13 +1118,12 @@ Where the project is heading; the sections before Audience document what ships t
1. In the library, the caller supplies everything that can change the output: data,
seed and date.
11. **No unnecessary runtime dependencies** — use standard library by default.
12. **Great documentation.**
13. **It is fast enough that you never notice it with the shipped data.**
12. **It is fast enough that you never notice it with the shipped data.**
1. A render's cost grows only with the data it reaches.
14. **Strongly prioritize data sourced from good online sources**
15. **The most common data comes first,** such as names, addresses, phone numbers and
13. **Strongly prioritize data sourced from good online sources**
14. **The most common data comes first,** such as names, addresses, phone numbers and
dates.
16. **Values look real by default. You can also ask for values that can never reach
15. **Values look real by default. You can also ask for values that can never reach
anything real,** such as a domain nobody can register.
## Layout
@@ -1312,7 +1312,7 @@ version.
### Documentation
How the README serves goal 12:
How the README serves goal 1.2:
- The top shows the CLI and the library side by side, each a short quickstart rendering
the same value.