Remove redundant types from docstrings #2941
Draft
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
surely sphinx can get that from the actual types?
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #2941 +/- ##
=======================================
Coverage 96.74% 96.74%
=======================================
Files 147 147
Lines 14978 14979 +1
=======================================
+ Hits 14491 14492 +1
Misses 487 487 ☔ View full report in Codecov by Sentry. |
If sphinx can't link objects because it doesn't recognise them, maybe lying about the context being type checking will work.
Setting TYPE_CHECKING apparently triggers a circular import error in urllib3 which is not great. Try an alternate option, checking if sphinx is imported. This is just to investigate if circular imports are an issue, as this would not be acceptable to release (there might be people using pygithub within sphinx for instance)
|
Crud, looks like trying to set |
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.
surely sphinx can get that from the actual types?