Skip to content

CLAUDE.md: fix pre-existing documentation-accuracy errors - #88

Merged
jnasbyupgrade merged 4 commits into
Postgres-Extensions:masterfrom
jnasbyupgrade:fix/claude-md-accuracy
Jul 31, 2026
Merged

CLAUDE.md: fix pre-existing documentation-accuracy errors#88
jnasbyupgrade merged 4 commits into
Postgres-Extensions:masterfrom
jnasbyupgrade:fix/claude-md-accuracy

Conversation

@jnasbyupgrade

Copy link
Copy Markdown
Contributor

Summary

Pre-existing factual errors in CLAUDE.md (and one small README.asc completeness 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 no HISTORY.asc entry.

  • make test "ensures" list: corrected to reflect actual behavior (testdeps -> install -> installcheck -> diffs shown) and added a note that make test intentionally does not depend on clean (already documented correctly in base.mk and README.asc; CLAUDE.md previously claimed the opposite).
  • Two-Phase Build System section: fixed 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 a "Phase 2" (meta.mk.sh) and new "Phase 3" (control.mk.sh) to match reality.
  • build_meta.sh description: corrected an 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 section: fixed "always creates git tag" — make tag skips creating the tag when it already exists and points at HEAD.
  • Scripts section: replaced a 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 — avoids future drift from hand-maintaining a duplicate list.
  • README.asc: noted that pgxntool-sync also verifies (and recreates if missing) the test/pgxntool symlink, not just the setup.sh-copied files.

Test plan

  • Re-read each edited section in context to confirm accuracy and that it doesn't contradict surrounding text
  • Confirmed each claim against source: 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)
  • Doc-only change; no code/behavior change, no test suite impact

🤖 Generated with Claude Code

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>
@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 966aa681-3418-4aa4-97c2-3c9788038607

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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.
@jnasbyupgrade
jnasbyupgrade merged commit 1a7ee20 into Postgres-Extensions:master Jul 31, 2026
4 checks passed
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