Skip to content

Conversation

@tammy-baylis-swi
Copy link
Contributor

@tammy-baylis-swi tammy-baylis-swi commented Oct 17, 2025

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 .rst snippets 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.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

  1. Virtualenv in Python 3.11
  2. tox -e docs
  3. Check local build in docs/_build/html/instrumentation/*

Does This PR Require a Core Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

See contributing.md for styleguide, changelog guidelines, and more.

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

@tammy-baylis-swi tammy-baylis-swi changed the title Update psycopg2, psycopg readthedocs on sqlcommenter Improve psycopg2, psycopg readthedocs on sqlcommenter Oct 17, 2025
@tammy-baylis-swi tammy-baylis-swi marked this pull request as ready for review October 18, 2025 00:03
@tammy-baylis-swi tammy-baylis-swi requested a review from a team as a code owner October 18, 2025 00:03
@xrmx xrmx moved this to Easy to review / merge / close in @xrmx's Python PR digest Oct 31, 2025
@xrmx xrmx merged commit 1923343 into open-telemetry:main Nov 3, 2025
896 of 897 checks passed
@github-project-automation github-project-automation bot moved this from Easy to review / merge / close to Done in @xrmx's Python PR digest Nov 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Improve documentation of instrumentation's sqlcommenter feature

3 participants