Include typehints in pdoc
#379
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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.
cdecker
approved these changes
Jun 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 ExposeSignerHandlein 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
pdocdoes a new release.I've created the PR as a draft to ensure I don't forget about it