-
Notifications
You must be signed in to change notification settings - Fork 610
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
Update docs for context lib #73
Conversation
Does this PR depend on or replace #70? |
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.
Apart from the two typos that travis/Sphinx complains about (looks like BaseRuntimeContext
is missing), LGTM.
The remaining failures seem like a Sphinx bug:
It seems Sphinx got confused while trying to find the base class "class reference target not found: opentelemetry.context.base_context.Slot", the path is wrong. @c24t any idea how to workaround this? I'll search and see if there are some solution. |
That looks like a sphinx bug to me, you may be able to track down the problem in https://github.com/agronholm/sphinx-autodoc-typehints/blob/master/sphinx_autodoc_typehints.py. |
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.
The changes LGTM, but hopefully we can find a way to fix the errors in sphinx before merging this to avoid having a broken build on master. If there's no way around it we can also disable the docs build check for now.
I've temporarily removed the |
* Add TimedEvent
This should address most of the context related issues discovered by @c24t in #70.
Part of the effort for #22.