A guide page for the four registries: where entries live, how targets point at them, the other new fields, the brace-reference table, what students never see, the lecture and glossary pages, every new error and lint rule, and the migration from terms.yaml and values.yaml. The setup guide points at it. The README covers glossary.yaml, the nine schemas, the 2.1 checks, the glossary lint family and the note severity, the new lecture commands and report sections, migrate glossary, and schema version 2.1. Module docs and the changelog follow. docs/design/2.1/CODES.md maps the specification's E, W, and I codes to coursebank's messages and lint codes, each with its test, and REPORT.md records what changed, the two remaining schema differences, every choice made where the specification left room, and suggested changes to it. A new test covers the validation messages the specification does not number. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
28 lines
1.3 KiB
Rust
28 lines
1.3 KiB
Rust
// SPDX-License-Identifier: Prosperity-3.0.0
|
|
// Copyright Scienting
|
|
// Source: https://git.scient.ing/education/coursebank
|
|
|
|
//! Support for writing items and building assessments from them.
|
|
//!
|
|
//! The three modules here are what you interact with before an exam exists, and
|
|
//! they divide by how much authority each one has.
|
|
//!
|
|
//! [`lint`] has none. Its 44 rules are advice with stable codes, every one
|
|
//! silenceable with `--ignore`, and the two that report notes never fail. It is deliberately separate from the validation in
|
|
//! [`crate::model::bank`], which enforces what must be true and fails. Conflating
|
|
//! the two produces a tool that either blocks you on style or lets real errors
|
|
//! through.
|
|
//!
|
|
//! [`select`] draws an assessment from a blueprint. It places objective minimums
|
|
//! before level quotas, because a coverage requirement is the constraint most
|
|
//! likely to become unsatisfiable, and it prefers least-recently-used items so a
|
|
//! bank rotates rather than converging on your favourites.
|
|
//!
|
|
//! [`jsonschema`] emits JSON Schema so an editor autocompletes the YAML. That is
|
|
//! a better authoring experience than any validator: catching `cognitve_process`
|
|
//! as you type beats reading it in a list afterward.
|
|
|
|
pub mod jsonschema;
|
|
pub mod lint;
|
|
pub mod select;
|