-
Notifications
You must be signed in to change notification settings - Fork 28
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
Include typehints in pdoc
#379
Conversation
Everything seems to pass alright, do you think this is ready to go in? Undraft it and it will be merged :-) |
There is github-action that only triggers on the |
Gotcha, I'll leave it here until I get your ok 👍 |
We should probably build the docs before we try to merge a PR. This will allow us to catch issues earlier. I'll create a separate MR for that. |
Did you want this to be merged before or after #407? I'm still not sure what this does to be honest |
We use pdoc to generate a reference of the python `glclient`-library. We suffered some issues related to missing type-hints. The work-around was to remove the type-hints before generating the docs. I've found 3 causes of warnings. 1. Missing export of `SignerHandle` (See Blockstream#368) 2. Poorly defined imports in auto-generated GRPC-code (See Blockstream#369) 3. pdoc failing to import type from type-stubs (See mitmproxy/pdoc#671) All of these 3 issues have been addressed so we don't need the hack anymore.
We use pdoc to generate a reference of the python
glclient
-library. We suffered some issues related to missing type-hints. The work-around was to remove the type-hints before generating the docs.I've found 3 causes of warnings.
SignerHandle
(See ExposeSignerHandle
in gl-client-py #368)All 3 have been addressed and we should be able to do without the work-around.
We can merge this once
pdoc
does a new release.I've created the PR as a draft to ensure I don't forget about it