Skip to content

Conversation

@dpage
Copy link
Contributor

@dpage dpage commented Nov 28, 2025

This patch improves the wording and grammar of a number of Python strings.

Summary by CodeRabbit

  • Bug Fixes

    • Corrected and standardized numerous user-facing messages and error texts for accuracy and punctuation (e.g., "reversed engineered" → "reverse‑engineered").
    • Clarified server/pgpass/process/PSQL status and termination messages.
    • MFA registration feedback now displays a successful flash when appropriate.
  • Documentation

    • Improved help text, labels, and prompts across dashboard, Query Tool, browser/editor preferences, and tools for clearer, more consistent UI wording.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Nov 28, 2025

Walkthrough

Textual updates across many pgAdmin modules: grammar, punctuation, capitalization, and message wording corrections in UI labels, help strings, and error/flash messages; one flash call now includes a success message type. No functional or control-flow changes.

Changes

Cohort / File(s) Summary
Reverse‑engineered phrasing fixes
web/pgadmin/browser/server_groups/servers/databases/casts/__init__.py, web/pgadmin/browser/server_groups/servers/databases/schemas/fts_configurations/__init__.py, web/pgadmin/browser/server_groups/servers/databases/schemas/fts_parsers/__init__.py, web/pgadmin/browser/server_groups/servers/databases/schemas/fts_templates/__init__.py, web/pgadmin/browser/server_groups/servers/roles/__init__.py
Replaced "reversed engineered" with hyphenated "reverse‑engineered" in SQL-generation error messages.
Preference/help text refinements
web/pgadmin/browser/register_browser_preferences.py, web/pgadmin/browser/register_editor_preferences.py, web/pgadmin/dashboard/__init__.py, web/pgadmin/tools/sqleditor/utils/query_tool_preferences.py
Grammar, punctuation, capitalization, and wording adjustments in preference labels and help strings.
General error/message wording & punctuation
web/pgadmin/browser/server_groups/servers/__init__.py, web/pgadmin/misc/bgprocess/processes.py, web/pgadmin/tools/import_export/__init__.py, web/pgadmin/tools/maintenance/__init__.py, web/pgadmin/utils/__init__.py
Standardized phrasing (e.g., "given" → "specified"), fixed "can not" → "cannot", and added/adjusted trailing punctuation in error/log messages.
MFA flash message correction
web/pgadmin/authenticate/mfa/views.py
Fixed message punctuation/quote and added MessageType.SUCCESS as the flash category when registering an already-registered MFA method.
Tool-specific UI & validation text updates
web/pgadmin/tools/debugger/__init__.py, web/pgadmin/tools/user_management/__init__.py, web/pgadmin/tools/psql/__init__.py
Minor label and message wording changes (e.g., "Switch Panel" → "Switch panel", validation and termination message rephrasing).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Attention areas:
    • Confirm MessageType.SUCCESS was imported/available where added in web/pgadmin/authenticate/mfa/views.py.
    • Verify placeholder formatting (e.g., '{0}') remains correct after wording changes.
    • Ensure hyphenation changes are consistent with style guidelines used elsewhere.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 69.23% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Python string cleanup' accurately reflects the primary objective of the pull request, which is to improve wording and grammar across multiple Python string literals throughout the codebase.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d749be1 and 3d5797a.

📒 Files selected for processing (4)
  • web/pgadmin/browser/register_editor_preferences.py (2 hunks)
  • web/pgadmin/browser/server_groups/servers/__init__.py (6 hunks)
  • web/pgadmin/tools/debugger/__init__.py (2 hunks)
  • web/pgadmin/tools/psql/__init__.py (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • web/pgadmin/tools/psql/init.py
🚧 Files skipped from review as they are similar to previous changes (1)
  • web/pgadmin/browser/server_groups/servers/init.py
🧰 Additional context used
🧬 Code graph analysis (1)
web/pgadmin/tools/debugger/__init__.py (1)
web/regression/javascript/fake_gettext.js (1)
  • gettext (40-42)
⏰ Context from checks skipped due to timeout of 900000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (12)
  • GitHub Check: run-python-tests-pg (windows-latest, 17)
  • GitHub Check: run-python-tests-pg (windows-latest, 16)
  • GitHub Check: run-feature-tests-pg (18)
  • GitHub Check: run-python-tests-pg (ubuntu-22.04, 18)
  • GitHub Check: run-python-tests-pg (macos-latest, 18)
  • GitHub Check: run-python-tests-pg (ubuntu-22.04, 17)
  • GitHub Check: run-python-tests-pg (ubuntu-22.04, 15)
  • GitHub Check: run-feature-tests-pg (17)
  • GitHub Check: run-feature-tests-pg (16)
  • GitHub Check: run-feature-tests-pg (14)
  • GitHub Check: run-feature-tests-pg (15)
  • GitHub Check: run-feature-tests-pg (13)
🔇 Additional comments (4)
web/pgadmin/tools/debugger/__init__.py (2)

213-218: Keyboard shortcut label now matches sentence‑case style

gettext('Switch panel') aligns with other shortcut labels like "Step into", "Next tab", etc., and is a pure wording tweak with no behavioral impact.


1656-1661: Error message wording improvement is safe

Changing the message to gettext('Error setting the value') improves grammar while preserving meaning; no surrounding logic or response structure is altered.

web/pgadmin/browser/register_editor_preferences.py (2)

333-334: LGTM! Improved grammar and clarity.

The capitalization and addition of the article "a" make this help text more grammatically correct and easier to read.


358-358: LGTM! Clearer explanation of zero-value behavior.

The rewording makes the zero-value behavior more explicit and easier for users to understand.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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