docs: the repository of its own: licences, CI, citations checked in form (P13 step 6)
spec/ and examples/ are CC BY 4.0, the code MIT OR Apache-2.0. The verbatim-pin and rules.md-id checks need wanderbooks' vendored sources and rules.md, so they move to wanderbooks; here a citation is checked in form. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HS8WZziDnyxunC23MUxrLp
This commit is contained in:
1 parent
82b53945c9
commit
fc4430c685
8 files changed
+678
-63
No files matched your search
@@ -1,13 +1,12 @@
|
||||
# bookspec: examples (seed)
|
||||
# bookspec
|
||||
|
||||
bookspec is the formal accounting specification planned in
|
||||
`plan/served.md` (P13, D-34): every rule stated normatively, sourced to its
|
||||
wanderbooks' `plan/served.md` (P13, D-34): every rule stated normatively, sourced to its
|
||||
authority, with a symbolic form and concrete examples, independent of any
|
||||
engine. Its own repository comes later. Until then this directory holds its
|
||||
first examples: P3's regression tests, each written here as it is built, so
|
||||
engine. `examples/` holds its first examples: P3's regression tests, each written here as it is built, so
|
||||
the spec starts from cases a real engine got wrong.
|
||||
|
||||
Every example is checked against wanderbooks on every `cargo test`
|
||||
Every example is checked against wanderbooks on every `cargo test` there
|
||||
(`crates/ledger-core/tests/bookspec.rs`, and for the formats appendix
|
||||
`crates/ledger-package/tests/package.rs`): an example the engine disagrees
|
||||
with fails the build, so the examples can't rot. An expected value is worked
|
||||
@@ -528,7 +527,19 @@ the GnuCash adapter: GnuCash has no reversal link, so it cannot answer
|
||||
## Licence and sources
|
||||
|
||||
The examples state rules in their own words with the paragraph cited
|
||||
(FASB's Codification is copyrighted: cited, never copied; see
|
||||
`docs/spec/sources/fasb-asc.md`). The examples are MIT OR Apache-2.0, as
|
||||
the rest of this repository, until bookspec moves to its own repository
|
||||
(planned: the spec under CC BY 4.0).
|
||||
(FASB's Codification is copyrighted: cited, never copied).
|
||||
|
||||
| What | Licence |
|
||||
|---|---|
|
||||
| `spec/` and `examples/` (the specification) | CC BY 4.0 (`LICENSE-CC-BY-4.0`) |
|
||||
| `checker/`, `runner/`, `gnucash/`, `lean/` (the code) | MIT OR Apache-2.0 (`LICENSE-MIT`, `LICENSE-APACHE`) |
|
||||
|
||||
## Home and consumers
|
||||
|
||||
The canonical home is `https://github.com/swaits/bookspec`; the mirror is
|
||||
`https://git.swaits.com/swaits/bookspec`. wanderbooks consumes this
|
||||
repository as a git dependency pinned to a commit, so its `just check`
|
||||
keeps running every example through `bookspec_checker::examples()`. The
|
||||
vendored authorities that `spec/` cites (`docs/spec/sources/`) and
|
||||
`docs/spec/rules.md` stay in wanderbooks, which checks the pins and the
|
||||
rule ids against `bookspec_checker::spec_files()`.
|
||||
Reference in new issue
Block a user