-
Notifications
You must be signed in to change notification settings - Fork 599
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
Consolidate instrumentation documentation in docstrings #754
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Was there a decision made to add the documentation here? Is this duplicating existing documentation?
@codeboten |
Read the description again. 👍 for keeping read the docs. We could also have our 4th generate script that allows us to keep docstrings as the single source of truth and generate everything else from that but this is fine as well as long as readthedocs contains the docs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just confirming this is moving all the documentation that would have ended up on pypi into the read the docs repo correct? Users should be able to access it via the links in each package.
Correct. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good, looks like a few things need fixing, otherwise the change looks great.
Haha so many generate scripts xD |
|
Updates instrumentation docstrings to include section on configuration. Most are related to
exclude_url
functionality andrequest/response
hooks. We want all of our documentation to exist in one place (readthedocs).