The old text served as the list of what a reader needs covered. The new text leads with what quak is, what it is for and how to use it. Every command, option, exit code and file layout follows in reference sections, then the library reference, then design, entrypoints and development. Every statement was checked against the code on next; the places where the old text disagreed with it are listed in the pull request. No sentence runs past about 30 words, every table is now a list, and no issue links or project history remain in text meant for users. Two code comments that named README sections now name the new ones. Model: fable-5-1
This commit is contained in:
+1
-1
@@ -4,7 +4,7 @@
|
|||||||
// Every line quak prints on stderr is a log line at one of six levels, from
|
// Every line quak prints on stderr is a log line at one of six levels, from
|
||||||
// the quietest: fatal, error, warning, info, debug, trace. A run prints the
|
// the quietest: fatal, error, warning, info, debug, trace. A run prints the
|
||||||
// lines at its own level and at every quieter one. Its level is info unless
|
// lines at its own level and at every quieter one. Its level is info unless
|
||||||
// `-v` or `-q` asks for another (see "CLI surface" in the README). Every
|
// `-v` or `-q` asks for another (see "What quak prints" in the README). Every
|
||||||
// command that exits non-zero logs a fatal line saying why, so even `-q`, which
|
// command that exits non-zero logs a fatal line saying why, so even `-q`, which
|
||||||
// prints only fatal lines, never leaves a non-zero exit unexplained. An error
|
// prints only fatal lines, never leaves a non-zero exit unexplained. An error
|
||||||
// line reports something that failed, such as a file or an album, and a
|
// line reports something that failed, such as a file or an album, and a
|
||||||
|
|||||||
@@ -418,7 +418,7 @@ describe("the first backup of the account", () => {
|
|||||||
expect(downloads.sort()).toEqual([100, 200, 300]);
|
expect(downloads.sort()).toEqual([100, 200, 300]);
|
||||||
});
|
});
|
||||||
|
|
||||||
// The tree "Backup layout" in the README describes. Each original is at
|
// The tree under "The backup directory" in the README. Each original is at
|
||||||
// its save path, `YYYY/YYYY-MM/YYYY-MM-DD/YYYY-MM-DD.<fileID>.<ext>`, with
|
// its save path, `YYYY/YYYY-MM/YYYY-MM-DD/YYYY-MM-DD.<fileID>.<ext>`, with
|
||||||
// the extension of its title; the live photo is its image and its video,
|
// the extension of its title; the live photo is its image and its video,
|
||||||
// each with the extension it had inside the ZIP, and a `.livephoto.json`
|
// each with the extension it had inside the ZIP, and a `.livephoto.json`
|
||||||
|
|||||||
Reference in New Issue
Block a user