Skip to content

Conversation

@cofin
Copy link
Member

@cofin cofin commented Oct 9, 2025

Summary

Removes unsupported performance claims, specific throughput numbers, and marketing buzzwords from documentation and docstrings throughout the codebase.

Changes

Removed Unbased Performance Claims

  • ❌ "3-5x faster than other PostgreSQL drivers" (asyncpg)
  • ❌ "~1.5-2x faster for simple queries" (psqlpy)
  • ❌ "~10% faster" (psycopg)
  • ❌ "10,000+ queries per second" (asyncpg)
  • ❌ "fastest Python PostgreSQL driver" (asyncpg)

Removed Marketing Buzzwords

  • ❌ "cutting-edge", "exceptional", "optimal", "maximum performance"
  • ❌ "enterprise-grade", "mission-critical", "massive"

Replaced With Factual Language

  • ✅ Specific technical features (Cython-based, Rust-based)
  • ✅ Architectural capabilities (connection pooling, async support)
  • ✅ Clear use case descriptions without hyperbole

Files Modified (10 total)

  • docs/extensions/adk/backends/asyncpg.rst
  • docs/extensions/adk/backends/psqlpy.rst
  • docs/extensions/adk/backends/psycopg.rst
  • docs/extensions/adk/backends/oracledb.rst
  • docs/extensions/adk/backends/bigquery.rst
  • docs/getting_started/introduction.rst
  • docs/usage/drivers_and_querying.rst
  • docs/extensions/adk/installation.rst
  • sqlspec/core/__init__.py (module docstring)
  • sqlspec/_serialization.py (function docstrings)

Impact

  • No code logic changes - only documentation
  • Preserves all technical accuracy and working examples
  • Improves credibility by avoiding unsupported claims
  • Maintains helpful context for choosing database adapters

Remove unsupported performance multipliers (3-5x, 10%, 1.5-2x),
specific throughput claims (10,000+ QPS), and marketing buzzwords
("cutting-edge", "exceptional", "optimal", "fastest", "enterprise-grade",
"mission-critical") from documentation and docstrings.

Replace with factual, professional descriptions that maintain technical
accuracy while avoiding hyperbole. Preserve all working examples and
architectural details.

Changes:
- asyncpg.rst: Remove "fastest driver" and "3-5x faster" claims
- psqlpy.rst: Remove "~1.5-2x faster" benchmark claims
- psycopg.rst: Remove "~10% faster" and "cutting-edge" language
- oracledb.rst: Replace "enterprise-grade" and "mission-critical"
- bigquery.rst: Replace "massive" with specific terms
- introduction.rst: Remove repeated "high-performance" claims
- core/__init__.py: Replace "maximum performance" with factual language
- _serialization.py: Remove "optimal performance" claims
- installation.rst: Remove "high-performance" descriptor
- drivers_and_querying.rst: Reduce "high-performance" overuse
@cofin cofin merged commit da709b7 into main Oct 9, 2025
9 of 10 checks passed
@cofin cofin deleted the docs-cleanup branch October 9, 2025 01:47
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.

2 participants