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
5 changed files with 8 additions and 8 deletions
Showing only changes of commit c55b296385 - Show all commits
+2 -2
View File
@@ -25,7 +25,7 @@ func loadData(sources []datafiles.Source) (map[string]node, error) {
return root, nil return root, nil
} }
// compileInto compiles each category it is handed into the folder place finds for its dir. // compileInto compiles each category it is handed into the folder place returns for its Folders.
func compileInto(place func(dir []string) *folder) func(datafiles.Category) error { func compileInto(place func(dir []string) *folder) func(datafiles.Category) error {
return func(c datafiles.Category) error { return func(c datafiles.Category) error {
n, err := compileCategory(c.JSON, c.Name, c.ReadRows) n, err := compileCategory(c.JSON, c.Name, c.ReadRows)
@@ -37,7 +37,7 @@ func compileInto(place func(dir []string) *folder) func(datafiles.Category) erro
} }
} }
// madeFolder is the folder dir names under root, made where it is missing or a category. // madeFolder is the folder that dir names under root, made where it is missing or a category.
func madeFolder(root *folder, dir []string) *folder { func madeFolder(root *folder, dir []string) *folder {
g := root g := root
for _, seg := range dir { for _, seg := range dir {
+1 -1
View File
@@ -827,7 +827,7 @@ Valid while names are read only inside the category binding them.
## comprehension floor: every dimension and the overall at 7.0 or above; item 5 scores the restructure, which ships unscored: every `{…}` drawing afresh, the moves into `internal/`, and items 101, 102 and 104 to 106 ## comprehension floor: every dimension and the overall at 7.0 or above; item 5 scores the restructure, which ships unscored: every `{…}` drawing afresh, the moves into `internal/`, and items 101, 102 and 104 to 106
2026-10-04, Lilleman auf Larv. Serves goal 3. The nine-seat panels in `todo.md`'s git history, 2026-09-22 to 2026-09-30, held the score between 5.2 and 6.1, with Locality lowest at every seat. The hardest units were the draw fences, which the change making every `{…}` draw afresh deleted. The restructure deletes or moves what the earlier chunks of the below-floor round touched. It is three things: the change making every `{…}` draw afresh; the moves of the draw state, the grammar, `DataType`, what a proof knows of a value, the builtins and the reading of data files into `internal/`; and `todo.md` items 101, 102 and 104 to 106. A scoring run before item 106 merges would score code about to go. The calc change accepting a name as an operand shipped unscored on 2026-10-05 for that reason. These are the restructure the maintainer approved, which `AGENTS.md`'s comprehension rule lets merge below the floor. No scoring run or panel runs until item 5, which runs the nine-seat panel and larv-review's scoring run. The scoring run writes this entry's first scores. Valid until `todo.md` item 5 runs. 2026-10-04, Lilleman auf Larv. Serves goal 3. The nine-seat panels in `todo.md`'s git history, 2026-09-22 to 2026-09-30, held the score between 5.2 and 6.1, with Locality lowest at every seat. The hardest units were the draw fences, which the change making every `{…}` draw afresh deleted. The restructure deletes or moves what the earlier chunks of the below-floor round touched. It is three things: the change making every `{…}` draw afresh; the moves of the draw state, the grammar, `DataType`, what a proof knows of a value, the builtins and the reading of data files into `internal/`; and `todo.md` items 101, 102 and 104 to 106. The maintainer approved these three, and `AGENTS.md`'s comprehension rule lets them merge below the floor. A scoring run before item 106 merges would score code about to go; for that reason the calc change accepting a name as an operand shipped unscored on 2026-10-05. No scoring run or panel runs until item 5, which runs the nine-seat panel and larv-review's scoring run. The scoring run writes this entry's first scores. Valid until `todo.md` item 5 runs.
## The template engine stays the root package until item 107; what reads no engine type sits in `internal/`, and items 101 and 102 move a table's rows there ## The template engine stays the root package until item 107; what reads no engine type sits in `internal/`, and items 101 and 102 move a table's rows there
+2 -2
View File
@@ -49,7 +49,7 @@ func (s Source) labelled(p string) string {
return path.Join(s.label, p) return path.Join(s.label, p)
} }
// dirPath is the folder dir names, as fsys spells it. // dirPath is the folder that dir names, as fsys spells it.
func (s Source) dirPath(dir []string) string { func (s Source) dirPath(dir []string) string {
if p := path.Join(append([]string{s.base}, dir...)...); p != "" { if p := path.Join(append([]string{s.base}, dir...)...); p != "" {
return p return p
@@ -77,7 +77,7 @@ func (s Source) Walk(compile func(Category) error) error {
return err return err
} }
// walkDir walks the folder dir names, and reports whether it handed over any category. // walkDir walks the folder that dir names, and reports whether it handed over any category.
func (s Source) walkDir(dir []string, compile func(Category) error) (bool, error) { func (s Source) walkDir(dir []string, compile func(Category) error) (bool, error) {
full := s.dirPath(dir) full := s.dirPath(dir)
entries, err := fs.ReadDir(s.fsys, full) entries, err := fs.ReadDir(s.fsys, full)
+1 -1
View File
@@ -71,7 +71,7 @@ func TestReadRowsReadsOnlyAFileBesideTheCategory(t *testing.T) {
return err return err
} }
if _, err := c.ReadRows("x.tsv"); err == nil || err.Error() != "rows names x.tsv, which is not beside it in "+map[string]string{"t": "lbl", "u": "lbl/sub"}[c.Name] { if _, err := c.ReadRows("x.tsv"); err == nil || err.Error() != "rows names x.tsv, which is not beside it in "+map[string]string{"t": "lbl", "u": "lbl/sub"}[c.Name] {
t.Errorf("ReadRows(x.tsv) = %v, want the file named missing beside %s", err, c.Name) t.Errorf("ReadRows(x.tsv) = %v, want an error saying x.tsv is not beside %s", err, c.Name)
} }
return nil return nil
}) })
+2 -2
View File
@@ -14,8 +14,8 @@ import (
"github.com/larvit/fejkdata/internal/invariant" "github.com/larvit/fejkdata/internal/invariant"
) )
// Facts is what a proof knows of every render of a node: bounds on the number each // Facts is what a proof knows of every render of a node: bounds on the number each render
// reads as, and per datatype why some render's text is not one ("" when none). // reads as, and, per datatype, why some render's text is not of it ("" when every render's is).
type Facts struct { type Facts struct {
Lo, Hi float64 Lo, Hi float64
NonZero float64 // every value is at least this far from zero; 0 when one can be zero NonZero float64 // every value is at least this far from zero; 0 when one can be zero