Skip to content

Reference

Plain-English, verifiable reference material for each tool, using RFC 2119 keywords:

  • MUST / MUST NOT: required; a violation is a bug.
  • SHOULD / SHOULD NOT: expected default behavior.
  • MAY: explicitly allowed, not required.

docs/reference/ states what each tool currently does, verified directly against source. Tests enforce a subset of these contracts; reference docs are not a substitute for tests, and a code change must keep both in sync.

A rule identical across more than one tool goes in shared, referenced by name instead of repeated in each tool's page.

  • change

    Compare an old/new polygon layer pair and classify every unit.

    change

  • Code

    code-refactor, code-update: assign or reconcile hierarchical codes.

    Code

  • Edge

    edge-clip, edge-extend, edge-match, edge-mosaic, edge-stitch: fit and stitch boundary layers together.

    Edge

  • Package

    package, package-lines, package-points, package-polygons: cartographic outputs for a web map.

    Package

  • Schema

    schema-crosswalk, schema-fill, schema-map, schema-refactor: crosswalk and fill a column schema.

    Schema

  • shared

    Common settings and gates shared across every tool.

    shared

  • Topo

    topo-clean, topo-detect: detect and fix single-layer coverage defects.

    Topo