Make great documentation goal 1.2, and plan the README's reorganisation and the nested-template gaps #33

Open
lilleman wants to merge 966 commits from worktree-todo-relative-dates-exact-counts into main
2 changed files with 7 additions and 4 deletions
Showing only changes of commit e54d1c06d6 - Show all commits
+5 -3
View File
@@ -292,10 +292,12 @@ ok, err := fejkdata.IsTemplate(arg) // an inline template by its shape, el
| `WithoutShippedData()` | load only what you give | | `WithoutShippedData()` | load only what you give |
`New` refuses a mistake in the data, and `NewTemplate` one in the template. On a loaded `New` refuses a mistake in the data, and `NewTemplate` one in the template. On a loaded
generator, each with the same error every call: generator:
- `Fake` fails only for a path that names nothing or could name two things. - `Fake` fails only for a path that names nothing or could name two things, with the
- `FakeStruct` fails only for a non-struct argument or a type its tags do not describe. same error every call.
- `FakeStruct` fails only for a non-struct argument or a type its tags do not describe,
with the same error every call.
- `Template.Fake` cannot fail. - `Template.Fake` cannot fail.
A `*Record` carries its columns via `Columns()` — each a `Column` of `Name`, A `*Record` carries its columns via `Columns()` — each a `Column` of `Name`,
+2 -1
View File
@@ -211,7 +211,8 @@ by a `data-import/` script, as README goal 12 asks.
- Report every mistake a load finds in one error, as the decision "A load reports every - Report every mistake a load finds in one error, as the decision "A load reports every
mistake at once" states: `New` and `NewTemplate` stop at the first, so data holding mistake at once" states: `New` and `NewTemplate` stop at the first, so data holding
two mistakes takes two runs to fix. Split it into sub-items before starting, one of two mistakes takes two runs to fix. Split it into sub-items before starting, one of
them the shape a Go caller iterates and the CLI prints, and reword the README's them the shape a Go caller iterates and the CLI prints, and the order of an
inline template's mistakes, which name no path; reword the README's
"`New` refuses a mistake in the data" to every mistake. "`New` refuses a mistake in the data" to every mistake.
- Rename `newRand` to `newGeneratorState` and `Generator.rand` to `state`: both name - Rename `newRand` to `newGeneratorState` and `Generator.rand` to `state`: both name
half of a `generatorState`, hiding its `{seq()}` counters, and `New`'s local `rng` half of a `generatorState`, hiding its `{seq()}` counters, and `New`'s local `rng`