Skip to content

Language editions: reference, comline fix, and the 1.0 rule - #160

Merged
Kinflou merged 1 commit into
mainfrom
docs/editions
Nov 9, 2026
Merged

Kinflou merged 1 commit into
mainfrom
docs/editions

Conversation

@Kinflou

@Kinflou Kinflou commented Nov 9, 2026

Copy link
Copy Markdown
Member

The docs for the editions work in #102: ComlineProject/core#217 and the comline fix command in cli.

  • Reference → Versioning → Editions (new section):
    • every package names its edition, and a missing or unknown one is an error with a fix;
    • a change that would break schemas already written ships in a new edition;
    • editions mix across dependencies, because each package compiles under its own and the compiled schema doesn't depend on it;
    • a word is deprecated, as a warning with a fix, before it's removed;
    • comline fix --edition N moves a package;
    • moving bumps nothing by itself.
  • Versioning manifest table: SpecificationVersion changed now reads none by itself, where it said major.
  • config.idp keys: specification_version is now required, links to Editions, and mentions comline fix.
  • CLI: adds a comline fix [--edition <n>] [--dry-run] row.
  • Phases: the 1.0 promises gain the edition rule.

Ordering: the CLI drift check reads cli's default branch, so it fails until the cli PR merges. Merge cli first, then re-run it.

Built: zensical build --strict passes locally with no issues.

Refs ComlineProject/core#102

core#102. Reference > Versioning gets an Editions section: every package
names one, breaking language changes ship in a new edition, editions
mix across dependencies, deprecation before removal, moving with
comline fix --edition N, and no bump by itself (the manifest table says
so too). config.idp's specification_version is required; the CLI page
lists comline fix; phases adds the edition rule to the 1.0 promises.
@Kinflou
Kinflou merged commit 49a85a3 into main Nov 9, 2026
3 of 4 checks passed
@Kinflou
Kinflou deleted the docs/editions branch November 9, 2026 04:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant