Repository navigation
Fix SQL example paths in documentation and CLI help - #424
Open
dajiaohuang wants to merge 1 commit into
Open
dajiaohuang wants to merge 1 commit into
dajiaohuang 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.
Problem
The README, manpage source and CLI help show commands using
samples/ex1.sql,samples/ex9.sqlandsamples/ex62.sql. There is nosamples/directory in the current repository, so those examples cannot locate their input files from the project root. The corresponding files are undert/test-files/.Change
Correct the paths consistently in
doc/pg_format.pod, README and CLI help. README example sections were regenerated withpod2text; unrelated existing README/POD differences were preserved rather than overwritten.Validation
57cd377321c8474a17ae59a139efa9c4019f21bd; corrected paths all exist.podchecker doc/pg_format.pod,perl -c pg_format, andgit diff --checkpass (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.