Skip to content

docs: add :members: to opentelemetry.propagate documentation#5172

Open
64johnlee wants to merge 1 commit intoopen-telemetry:mainfrom
64johnlee:docs/propagate-members
Open

docs: add :members: to opentelemetry.propagate documentation#5172
64johnlee wants to merge 1 commit intoopen-telemetry:mainfrom
64johnlee:docs/propagate-members

Conversation

@64johnlee
Copy link
Copy Markdown

Summary

Fixes #2573 - Some documentation not built into sphinx docs

The opentelemetry.propagate module exports extract(), inject(), get_global_textmap(), and set_global_textmap() functions, but the sphinx docs were not including them because the automodule directive lacked the :members: flag.

Changes

In docs/api/propagate.rst:

  • Added :members: to the automodule directive so that module-level functions are documented
  • Added :undoc-members: and :show-inheritance: for completeness

Before:

.. automodule:: opentelemetry.propagate

After:

.. automodule:: opentelemetry.propagate
    :members:
    :undoc-members:
    :show-inheritance:

Fixes #2573

Fixes open-telemetry#2573 - Some documentation not built into sphinx docs

The opentelemetry.propagate module has extract(), inject(), get_global_textmap(),
and set_global_textmap() functions that were not included in the sphinx docs.
Adding :members: and :undoc-members: to the automodule directive ensures these
are documented.
@64johnlee 64johnlee requested a review from a team as a code owner May 5, 2026 00:16
@linux-foundation-easycla
Copy link
Copy Markdown

linux-foundation-easycla Bot commented May 5, 2026

CLA Missing ID

  • ❌ The email address for the commit (c244ad3) is not linked to the GitHub account, preventing the EasyCLA check. Consult this Help Article and GitHub Help to resolve. (To view the commit's email address, add .patch at the end of this PR page's URL.) For further assistance with EasyCLA, please visit our EasyCLA portal and chat with our support bot.

@tammy-baylis-swi
Copy link
Copy Markdown
Contributor

Thanks @64johnlee . I believe this will not duplicate existing https://github.com/open-telemetry/opentelemetry-python/pull/5017/changes

Please could you sign the CLA?

@tammy-baylis-swi tammy-baylis-swi moved this to Reviewed PRs that need fixes in Python PR digest May 5, 2026
@64johnlee
Copy link
Copy Markdown
Author

64johnlee commented May 6, 2026 via email

@MikeGoldsmith
Copy link
Copy Markdown
Member

@64johnlee if you click the image above where it says Signed Agreement Missing on the CLA bot reply, it'll take you to the CLA page.

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Reviewed PRs that need fixes

Development

Successfully merging this pull request may close these issues.

Some documentation not built into sphinx docs

3 participants