docs: add :members: to opentelemetry.propagate documentation#5172
Open
64johnlee wants to merge 1 commit intoopen-telemetry:mainfrom
Open
docs: add :members: to opentelemetry.propagate documentation#517264johnlee wants to merge 1 commit intoopen-telemetry:mainfrom
64johnlee wants to merge 1 commit intoopen-telemetry:mainfrom
Conversation
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.
|
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? |
Author
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
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.
Summary
Fixes #2573 - Some documentation not built into sphinx docs
The
opentelemetry.propagatemodule exportsextract(),inject(),get_global_textmap(), andset_global_textmap()functions, but the sphinx docs were not including them because theautomoduledirective lacked the:members:flag.Changes
In
docs/api/propagate.rst::members:to theautomoduledirective so that module-level functions are documented:undoc-members:and:show-inheritance:for completenessBefore:
After:
Fixes #2573