Improve psycopg2, psycopg readthedocs on sqlcommenter#3882
Merged
xrmx merged 9 commits intoNov 3, 2025
Conversation
tammy-baylis-swi
changed the title
10 tasks
emdneto
approved these changes
Oct 27, 2025
xrmx
approved these changes
Nov 3, 2025
github-project-automation
Bot
moved this from Easy to review / merge / close
to Done
in Python PR digest
sightseeker
added a commit
to sightseeker/opentelemetry-python-contrib
that referenced
this pull request
Mar 11, 2026
…#3882) * Update psycopg2,psycopg docs on sqlcommenter * changelog * Fix table format * Fix underline * Fix quotes * Add warning about db.statement cardinality --------- Co-authored-by: Riccardo Magliocchetti <riccardo.magliocchetti@gmail.com>
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
3 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.
Description
Updates the psycopg2 and psycopg instrumentor readthedocs with sqlcommenter information. Based on the recent changes to the DB-API docs update in #3720, deployed to contrib readthedocs. Also fixes typos, bad original framework docs links in their top-level readmes.
I thought about generating
.rstsnippets to share between DB-API, psycopg2, psycopg, and other instrumentors to reduce duplication. But I wasn't sure of a good place to put them. Ideas?Partially fixes #3162
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
tox -e docsdocs/_build/html/instrumentation/*Does This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.