Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable documentation for Instrumentor classes #170

Closed
mauriciovasquezbernal opened this issue Apr 27, 2020 · 2 comments
Closed

Enable documentation for Instrumentor classes #170

mauriciovasquezbernal opened this issue Apr 27, 2020 · 2 comments
Labels

Comments

@mauriciovasquezbernal
Copy link
Member

Each integration should implement the _instrument and _uninstrument methods according to the BaseInstrumentor interface. Those methods are private and are not included in the documentation with the current configuration: https://opentelemetry-python.readthedocs.io/en/latest/ext/flask/flask.html#api.

We could enable them by using :private-members:, but probably it's too much and will include documentation of members we don't want to, another issue is that the documented name would include the underscore, and we want the user to call the method without it on the BaseInstrumentor class. Also, we don't have a way to document the parameters that those methods could take as they are declared as **kwargs.

@lzchen lzchen transferred this issue from open-telemetry/opentelemetry-python Nov 9, 2020
@github-actions
Copy link

github-actions bot commented Apr 6, 2021

This issue was marked stale due to lack of activity. It will be closed in 30 days.

@codeboten
Copy link
Contributor

nstawski pushed a commit to nstawski/ns-opentelemetry-python-contrib that referenced this issue May 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants