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

Error in urllib3 instrumentation example in instrumentation documentation #1767

Closed
JM-ET opened this issue Apr 20, 2023 · 3 comments
Closed
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@JM-ET
Copy link

JM-ET commented Apr 20, 2023

Describe your environment
https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/urllib3/urllib3.html
section: Request/Response hooks
Contains an error in example which causes pylint
no-value-for-parameter (self)

Steps to reproduce
Current example on this page:
URLLib3Instrumentor.instrument(
request_hook=request_hook, response_hook=response_hook)
)

What is the expected behaviour?
Works and runs successfully

What is the actual behaviour?
pylint - no-value-for-parameter (self)
And fails to run if disable lint check

Correction
Need to create an instance of URLLib3Instrumentor - missing () after class name

URLLib3Instrumentor().instrument(
request_hook=request_hook, response_hook=response_hook)
)

example under section: Usage is correct, just not this example.

@JM-ET JM-ET added the bug Something isn't working label Apr 20, 2023
@srikanthccv
Copy link
Member

Thanks for the report. Feel free to send a pull request.

@srikanthccv srikanthccv added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Apr 28, 2023
@yashaswi2000
Copy link
Contributor

can i pick this issue up, if this is not already being worked on. thanks!

@JM-ET
Copy link
Author

JM-ET commented May 9, 2023 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants