CLAUDE.md: fix pre-existing documentation-accuracy errors - #88
Merged
jnasbyupgrade merged 4 commits intoJul 31, 2026
Merged
Conversation
Found during 2.3.0 release-prep API-documentation audit; unrelated to any code change in that release. - make test: correct the 'ensures' bullet list to reflect actual behavior (testdeps -> install -> installcheck -> diffs shown), and note that make test intentionally does NOT depend on clean (base.mk already documents this; README.asc already stated it correctly). - Two-Phase Build System: fix misattribution of which script generates which variables. meta.mk.sh only emits PGXN/PGXNVERSION into meta.mk; EXTENSIONS, EXTENSION_*_VERSION, and EXTENSION__CURRENT_VERSION__FILES are generated by control.mk.sh from .control files into control.mk, not by meta.mk.sh from META.json. Split into Phase 2 (meta.mk.sh) and Phase 3 (control.mk.sh) to match reality. - build_meta.sh: correct overstated claim that it strips X_comment fields; it only strips lines with an empty string value, which incidentally removes some (not all) X_comment placeholder lines. - Distribution Packaging: fix 'always creates git tag' -- make tag skips creating the tag when it already exists at HEAD. - Scripts section: replace the stale, hand-maintained list (missing pgxntool-sync.sh, update-setup-files.sh, pgtle.sh, control.mk.sh) with a pointer to each script's own header comment, which already documents its purpose. README.asc: note that pgxntool-sync also verifies (and recreates if missing) the test/pgxntool symlink, not just the setup.sh-copied files. Co-Authored-By: Claude <noreply@anthropic.com>
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
The prior fix still listed every script name in a parenthetical, which would go stale exactly the same way the list it replaced did.
No reason to limit this to shell scripts specifically; a future script in any language should be covered by the same guidance.
"this directory's root" was ambiguous outside the context of the file itself; spell out that it means the top level of the pgxntool repo.
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
Pre-existing factual errors in
CLAUDE.md(and one smallREADME.asccompleteness fix) found during an API-documentation audit ahead of the 2.3.0 release. These are documentation-accuracy fixes only, unrelated to any code change in the 2.3.0 release — no behavior changes, so noHISTORY.ascentry.make test"ensures" list: corrected to reflect actual behavior (testdeps->install->installcheck-> diffs shown) and added a note thatmake testintentionally does not depend onclean(already documented correctly inbase.mkandREADME.asc;CLAUDE.mdpreviously claimed the opposite).meta.mk.shonly emitsPGXN/PGXNVERSIONintometa.mk.EXTENSIONS,EXTENSION_*_VERSION, andEXTENSION__CURRENT_VERSION__FILESare generated bycontrol.mk.shfrom.controlfiles intocontrol.mk— not bymeta.mk.shfromMETA.json. Split into a "Phase 2" (meta.mk.sh) and new "Phase 3" (control.mk.sh) to match reality.build_meta.shdescription: corrected an overstated claim that it stripsX_commentfields; it only strips lines with an empty string value, which incidentally removes some (not all)X_commentplaceholder lines.make tagskips creating the tag when it already exists and points at HEAD.pgxntool-sync.sh,update-setup-files.sh,pgtle.sh,control.mk.sh) with a pointer to each script's own header comment, which already documents its purpose — avoids future drift from hand-maintaining a duplicate list.README.asc: noted thatpgxntool-syncalso verifies (and recreates if missing) thetest/pgxntoolsymlink, not just thesetup.sh-copied files.Test plan
base.mk(test/clean dependency, tag skip-if-at-HEAD),meta.mk.sh/control.mk.sh(variable generation),build_meta.sh(empty-value stripping),update-setup-files.sh/lib.sh(symlink verification)🤖 Generated with Claude Code