Make great documentation goal 1.2, and plan the README's reorganisation and the nested-template gaps #33
@@ -829,9 +829,11 @@ the output.
|
|||||||
|
|
||||||
Semver tags on `main`, `v0.1.0` first; one version covers the shipped data, the
|
Semver tags on `main`, `v0.1.0` first; one version covers the shipped data, the
|
||||||
library and the CLI, and [`CHANGELOG.md`](CHANGELOG.md) names what each release
|
library and the CLI, and [`CHANGELOG.md`](CHANGELOG.md) names what each release
|
||||||
changed. A consumer's data, code and scripts keep working across a minor or a patch,
|
changed. A consumer's data, code and scripts keep working across a minor or a patch. A
|
||||||
except output pinned to a seed. A minor only adds, and a major is the only release that
|
minor only adds, and a major is the only release that changes what exists. Seeded output
|
||||||
changes what exists.
|
is the exception: any release, a patch too, may change what a seed draws. Where you
|
||||||
|
compare seeded output, install one exact version (`go install …@vX.Y.Z`; `go.mod` already
|
||||||
|
pins one), and regenerate seeded fixtures and expected values when you raise it.
|
||||||
|
|
||||||
| Surface | Major | Minor |
|
| Surface | Major | Minor |
|
||||||
|---------|-------|-------|
|
|---------|-------|-------|
|
||||||
@@ -844,9 +846,6 @@ changes what exists.
|
|||||||
A patch changes no row of this table: performance, docs, or a fix inside a promised
|
A patch changes no row of this table: performance, docs, or a fix inside a promised
|
||||||
behaviour that adds or removes no value and changes no path, format or spelling.
|
behaviour that adds or removes no value and changes no path, format or spelling.
|
||||||
|
|
||||||
Any release, a patch too, may change what a seed draws, so regenerate seeded fixtures
|
|
||||||
whenever the fejkdata version changes.
|
|
||||||
|
|
||||||
An error's wording may improve in a minor; the path, rejected spelling and replacement
|
An error's wording may improve in a minor; the path, rejected spelling and replacement
|
||||||
it names may not.
|
it names may not.
|
||||||
|
|
||||||
|
|||||||
@@ -48,7 +48,7 @@ array, one JSON object per line, one CSV row (after a header), or one INSERT.
|
|||||||
--list list the paths the data offers, then exit
|
--list list the paths the data offers, then exit
|
||||||
--no-shipped-data load only the --data-path directories
|
--no-shipped-data load only the --data-path directories
|
||||||
-n, --repeat N render the value N times, 1..1048576 (default 1)
|
-n, --repeat N render the value N times, 1..1048576 (default 1)
|
||||||
-s, --seed N seed: the same seed, version and data give identical output
|
-s, --seed N same seed, version and data: identical output
|
||||||
--separator S string between repeated values (default newline)
|
--separator S string between repeated values (default newline)
|
||||||
--table T the INSERT target for --format sql (default: the path's last segment, or records for an inline template)
|
--table T the INSERT target for --format sql (default: the path's last segment, or records for an inline template)
|
||||||
--version print the version, then exit
|
--version print the version, then exit
|
||||||
|
|||||||
Reference in New Issue
Block a user