fix: correct stale version numbers and update version-increment check… - #106
Open
djkees wants to merge 1 commit into
Open
fix: correct stale version numbers and update version-increment check…#106djkees wants to merge 1 commit into
djkees wants to merge 1 commit into
Conversation
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
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.
Summary
Corrects stale version numbers (
3.0) in two doc-generator config files that were left behind at previous releases, and closes the gap in the version-increment checklist that let this happen.Note: this change has no visible effect on the currently published docs site — see the "Investigated impact" notes below.
Changes
project.md:version: 3.0→3.3.2(FORD doc-generator metadata)Doxyfile:PROJECT_NUMBER = 3.0→3.3.2(Doxygen config).codex/skills/version-increment/SKILL.md: added both files to the known hard-coded version locations listInvestigated impact before fixing:
project.md/FORD: not referenced anywhere in the repo outside itself — appears unused by the current docs pipeline (docs.ymlonly invokes Doxygen + Sphinx, neverford). I corrected the value here in case FORD is still intended for future use, but if it's actually dead weight, happy to open a follow-up PR removingproject.mdentirely instead — just let me know which you'd prefer.Doxyfile: actively used — invoked bydocs.ymlin CI, and referenced indeveloper_guide.rst/faq.rst/installation.rstfor local dev workflows — butPROJECT_NUMBERspecifically feeds the intermediate Doxygen→Breathe→Sphinx pipeline and doesn't appear to render on the published site. The live docs' correct version comes fromdocs/source/conf.py, which was already accurate.Testing
ctestnot applicable — no solver/numerics changes.doxygen Doxyfiledirectly to confirm the corrected value doesn't break XML generation — completed successfully (one pre-existing, unrelatedDOT_MULTI_TARGETSdeprecation warning, unaffected by this change).project.mdandSKILL.mdhave no associated build/test step (confirmed via repo-wide text search for each filename, excluding build artifacts).Compatibility / Numerical behavior
I used Claude to help investigate this repo's docs pipeline and draft this description; the findings above were verified directly against the source (grep searches, reading
docs.yml, runningdoxygen Doxyfilelocally, and inspecting the generated XML/HTML output) rather than taken on faith.