Skip to content

Fix SQL example paths in documentation and CLI help - #424

Open
dajiaohuang wants to merge 1 commit into
darold:masterfrom
dajiaohuang:repostew/fix-example-paths-20261016
Open

dajiaohuang wants to merge 1 commit into
darold:masterfrom
dajiaohuang:repostew/fix-example-paths-20261016

Conversation

@dajiaohuang

Copy link
Copy Markdown

Problem

The README, manpage source and CLI help show commands using samples/ex1.sql, samples/ex9.sql and samples/ex62.sql. There is no samples/ directory in the current repository, so those examples cannot locate their input files from the project root. The corresponding files are under t/test-files/.

Change

Correct the paths consistently in doc/pg_format.pod, README and CLI help. README example sections were regenerated with pod2text; unrelated existing README/POD differences were preserved rather than overwritten.

Validation

  • Checked all 13 references across the three files: original paths do not exist at master 57cd377321c8474a17ae59a139efa9c4019f21bd; corrected paths all exist.
  • Verified the diff in all three files changes only the directory prefix.
  • podchecker doc/pg_format.pod, perl -c pg_format, and git diff --check pass (Ubuntu 24.04 / Perl 5.38.2).

The repository SQL examples were not executed or formatted for this path-only correction. Normal CLI formatting was checked separately using small synthetic SQL inputs; no SQL/database execution was used.

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