Skip to content

docs: fix README escaping marker in ENVSUB example#1037

Merged
mfridman merged 1 commit intopressly:mainfrom
tooilxui:fix/readme-envsub-dollar-escaping
Mar 4, 2026
Merged

docs: fix README escaping marker in ENVSUB example#1037
mfridman merged 1 commit intopressly:mainfrom
tooilxui:fix/readme-envsub-dollar-escaping

Conversation

@tooilxui
Copy link
Copy Markdown
Contributor

@tooilxui tooilxui commented Mar 4, 2026

Fix typo in README: the text says "exclude escaping the ** characters" but the example is about excluding escaping the 11 delimiters used in PL/pgSQL.\n\nChange is limited to that single sentence.

Copilot AI review requested due to automatic review settings March 4, 2026 05:22
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the README documentation for Goose’s ENVSUB annotation to correctly reference PL/pgSQL dollar-quoting delimiters, aligning the explanatory sentence with the example shown.

Changes:

  • Corrects the delimiter mentioned in the ENVSUB/PL/pgSQL example from ** to $$.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@tooilxui tooilxui force-pushed the fix/readme-envsub-dollar-escaping branch from a10158a to 4d1b8fe Compare March 4, 2026 05:36
@tooilxui
Copy link
Copy Markdown
Contributor Author

tooilxui commented Mar 4, 2026

Hi @mfridman — I’ve opened a small docs PR: #1037.

It fixes a mismatch in the README ENVSUB example: the text mentioned ** as the PL/pgSQL dollar-quoting delimiter, but the example uses $$. This updates the description to $$ to match the example and avoid confusion.

No code changes—docs-only. If it looks good to you, could you please review/merge? Thanks!

Copy link
Copy Markdown
Collaborator

@mfridman mfridman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@mfridman mfridman merged commit 65e320f into pressly:main Mar 4, 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.

3 participants