tighten advisor copy for pg_graphql and secdef lints#161
Merged
Conversation
dnywh
commented
Apr 27, 2026
Contributor
Author
There was a problem hiding this comment.
Adds these new lints to the sidebar/nav.
dnywh
commented
Apr 27, 2026
Comment on lines
+35
to
+39
| **Copy guidance for Advisor surfaces:** | ||
| - Keep `description` to 1-2 short sentences: what the lint detects and the first likely action. | ||
| - Keep `detail` concise and object-specific. It should describe the failing object, not restate the full rationale. | ||
| - Put deeper explanation, edge cases, and extended remediation in `docs/XXXX_<name>.md`, not in the SQL strings. | ||
|
|
Contributor
Author
There was a problem hiding this comment.
For future lints. Helps make the Advisor side on Studio easier to read (and lints for consistent).
samrose
approved these changes
Apr 27, 2026
samrose
approved these changes
Apr 27, 2026
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
2 participants
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
Tightens the user-facing copy for the four pg_graphql / SECURITY DEFINER security lints added in #158 and #160.
This keeps the lint logic the same and focuses on making the titles, issue text, and top-level docs copy easier to act on.
What changed
descriptionanddetailcopy to be more direct and action-orientedSummaryandRamificationsections in the matching docs pagessplinter.sql