Skip to content

doc(stela): rename the third version segment to patch - #67

Merged
kniz merged 1 commit into
mainfrom
doc/stela-version-patch
Sep 8, 2026
Merged

kniz merged 1 commit into
mainfrom
doc/stela-version-patch

Conversation

@kniz

@kniz kniz commented Sep 7, 2026

Copy link
Copy Markdown
Member

Why

verStela's third version segment is being renamed fix -> patch in
byeolang/stela#10. This document is the last place still calling it fix, and
its two verified C++ examples call asFix().

patch is what semver and every package manager downstream of it call that
slot, and this project already writes PATCH everywhere else — build-common's
by_parse_ver exports BY_VER_PATCH from the same number in CHANGELOGS.md.
Only the C++ API and this page said fix.

What changed

The version section now documents major.minor.patch plus the optional
fourth segment, revision, with the reason it is a real segment rather than
semver's +build metadata: the spec requires build metadata to be ignored
when comparing versions, and a revision has to compare. The names follow .NET's
major.minor.build.revision and Debian's
upstream_version-debian_revision, which agree on both the meaning and the
rule that the fourth segment resets when anything above it moves.

Two verified examples now call asPatch().

Two staleness fixes in the same document

Not part of the rename, but both are this page contradicting the code it
documents, and both are one-liners:

On the verified badge

The document convention says C++ blocks get verified without an automated
check, since there is no online way to run them. So I ran both changed
examples against stela's own test harness (byeolTest, on the branch for
byeolang/stela#10) before committing — they compile and pass. That is also how
the broken stela root("root") line surfaced.

Ordering

This depends on byeolang/stela#10, which carries the actual rename. Merge that
first, or this page will describe an API that does not exist yet.

verStela's third segment is `patch` now, matching semver and the PATCH that
build-common already parses out of CHANGELOGS.md. This document was the last
place still calling it `fix`, and its two verified examples called asFix().

The version section also gains the optional fourth segment, `revision`, and
the reason it is a real segment rather than semver's `+build` metadata: the
spec requires that metadata be ignored when comparing, and a revision has to
compare.

Two things in the same document had gone stale against the code and are
corrected here rather than left to contradict it: the tree-API example built
a bare `stela`, which stopped compiling when stela became an ADT, and the
class diagram predates defStela and rootStela. Both examples were run against
the stela test harness before this commit.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 122f792d0f

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

ASSERT_EQ(ver.asMajor(), 1);
ASSERT_EQ(ver.asMinor(), 0);
ASSERT_EQ(ver.asFix(), 8);
ASSERT_EQ(ver.asPatch(), 8);

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Update the stela pin before calling asPatch

The core build still fetches byeolang/stela at GIT_TAG ade6414 in module/core/CMakeLists.txt, while this commit's own message says asPatch() exists only in the pending stela#10 change. Until the dependency is released and this repository's pin is advanced, this newly marked verified example (and the identical one below) does not compile against the version Byeol actually builds and documents.

Useful? React with 👍 / 👎.

@codecov

codecov Bot commented Sep 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@kniz
kniz merged commit df350a4 into main Sep 8, 2026
10 checks passed
@kniz
kniz deleted the doc/stela-version-patch branch September 8, 2026 06:32
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