Skip to content

A little doc elaboration #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AMDmi3 merged 1 commit into from
Aug 21, 2025
Merged

A little doc elaboration #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions doc/ALGORITHM.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

2. Components are assigned ranks by their value:

* **PRE_RELEASE** - known pre-release keyword (`alpha`, `beta`, `rc`).
* **PRE_RELEASE** - known pre-release keyword (`alpha`, `beta`, `pre`, `rc`).
* **ZERO** - numeric component equal to zero.
* **POST_RELEASE** - known post-release keyword (`patch`, `post`, `pl`).
* **NONZERO** - numeric component not equal to zero.
Expand All @@ -20,9 +20,10 @@

A special case exists for alphabetic component which follows
numeric component, and is not followed by another numeric
component (`1.0a`, `1.0a.1`, but not `1.0a1`). Such alphabetic
component is assigned a different rank, **LETTER_SUFFIX**, which
follows **NONZERO** (choice of this behavior explained below).
component after a delimiter (`1.0a`, `1.0a.1`, but not `1.0a1`
because of lack of delimiter). Such alphabetic component is
assigned a different rank, **LETTER_SUFFIX**, which follows
**NONZERO** (choice of this behavior explained below).

3. Versions are compared component-wise.

Expand Down