docs(getting-started): stop pinning a stale version in installation.md (closes #30) - #41
Merged
OpenComplaiCTO merged 1 commit intoAug 19, 2026
Conversation
`Latest release: **0.1.2** on PyPI` had drifted three minor versions behind, and the same stale number appeared twice more in the "Verify the installation" tabs as `pip show` example output. Replace the standalone claim with a link to the PyPI release history so it cannot go stale on the next release, per the suggestion on the issue. While removing the other two, the surrounding sentence turned out to be wrong as well: it states "The CLI does not expose a `--version` flag", but `main.py` has declared a `--version`/`-V` option (and a `version` subcommand) for some time - both print the version and exit 0. Point the verification steps at `--version` instead of at a `pip show` line whose comment has to be hand-maintained, and mention `pip show` only as the way to get full distribution metadata. Closes Opencomplai#30 Signed-off-by: dchaudhari7177 <111210939+dchaudhari7177@users.noreply.github.com>
dchaudhari7177
force-pushed
the
docs/installation-stale-version
branch
from
August 17, 2026 20:07
d25a9d8 to
a86b4ea
Compare
OpenComplaiCTO
approved these changes
Aug 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #30
What was stale
The issue points at line 43, but
0.1.2appeared three times ininstallation.md:Latest release: **0.1.2** on PyPI.pip show opencomplai # Version: 0.1.2(macOS / Linux tab)pip show opencomplai # Version: 0.1.2(Windows tab)Line 43 is now a link to the PyPI release history rather than a number, which is the "doesn't go stale on every release" option the issue preferred.
One extra correction
Removing the other two meant rewriting the sentence that introduces them, and that sentence is also wrong:
It does.
main.pydeclares a--version/-Voption and aversionsubcommand. Checked against this branch:So the verification steps now use
opencomplai --versioninstead of apip showline carrying a hand-maintained version comment — which is what let the number drift in the first place.pip showis still mentioned, as the way to get full distribution metadata.Scope
Docs only — one file, +9/-5. No code touched, so the pre-existing
packages/clitest failures and lint state onmainare unaffected either way.I did not touch the version numbers declared in the package metadata;
--versionreports0.2.0from the installed metadata whilepackages/cli/pyproject.tomlsays0.3.0, which looks like a separate release-process question rather than something to settle in a docs PR. Flagging it in case it's news.