A note records one thing about an Excel function that someone matching Excel, or explaining an Excel result, needs to know. Notes are harvested in batches from findings that have already landed (reports, evidence, product commits). Writing a note is never a step of a fix, and no other repository's work or commit depends on one.
- Copy an existing
content/notes/FN-*.jsonand rename itFN-<FUNCTION>-<nnn>.json(the next free number for that function;<FUNCTION>as indata/functions/FUNC.<FUNCTION>.json). - Fill it in:
functions: everyFUNC.*id it applies to, sorted.kind:quirk,excel-differs-from-math(needs a repro withcorrect, the exact mathematically correct value),bit-matching-detail, ordocumentation-differs(needsdocumentation).statement: what Excel does, with its scope. Only what the evidence shows.status:measured(read off recorded Excel answers) orinferred(goes beyond them; put the inferred part ininferred).basissays what the status rests on.repros: the call, the exact inputs (displaymust parse tobits), Excel's answer,recorded_in(Excel build, platform, CPU) andsource(where the reading is kept).evidence: repository, full commit, path, locator, for the product commit, research write-up and readings. Evidence that exists only in a working folder is copied tocontent/notes/evidence/<date>/first and cited at that commit.
- Run
dotnet run --project tools/efh/Efh.Rubric.Cli -- notes renderfrom the repository root. It checks the notes and writes the Notes section of each named function page,NOTES.mdandsite/api/notes.json.notes checkdoes the same without writing. - Run
dotnet test tests/Efh.Rubric.Testsand commit.
Do not use the equality phrases CHARTER 7.8 forbids; say what matched, on how many rows, in which
build. The format is tools/schemas/f20-function-note.schema.json.