CODE_STYLE.md: add no-unexplained-abbreviations convention - #25
Open
jnasbyupgrade wants to merge 1 commit into
Open
jnasbyupgrade wants to merge 1 commit into
jnasbyupgrade wants to merge 1 commit into
Conversation
Prompted by object_reference#41 review: a temp table's column names (evtname/evtenabled) deliberately mirrored pg_event_trigger's own columns, but with no visible connection to that source it read as an unexplained abbreviation. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Advanced Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
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. Comment |
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
1 participant
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.
Spell out identifiers unless the shorter form is already established Postgres/domain vocabulary or forced by Postgres's identifier-length limit — an invented local abbreviation makes a reader work out that it's an abbreviation before they can even start guessing what it stands for.
Carves out mirroring an existing catalog's own column names (e.g.
pg_event_trigger'sevtname/evtenabled) as legitimate, provided the mirroring is made visible in the code itself (CREATE TABLE ... AS SELECT ... FROM pg_catalog.pg_event_trigger WHERE false, orLIKE) rather than a hand-typed column list with no visible connection to its source.Prompted by review feedback on object_reference#41.
🤖 Generated with Claude Code