[python] add type hints in docs/conf.py #4526
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
12 tasks
StrikerRUS
reviewed
Aug 17, 2021
docs/conf.py
Outdated
| @@ -197,7 +198,7 @@ def run(self): | |||
| latex_logo = str(CURR_PATH / 'logo' / 'LightGBM_logo_black_text_small.png') | |||
|
|
|||
|
|
|||
| def generate_doxygen_xml(app): | |||
| def generate_doxygen_xml(app: Any) -> None: | |||
There was a problem hiding this comment.
Maybe use sphinx.application.Sphinx for app (here and at L246 and L308)?
https://www.sphinx-doc.org/en/master/extdev/appapi.html
There was a problem hiding this comment.
Sure, can do. I was just following the documentation below.
Parameters
----------
app : object
The application object representing the Sphinx process.
There was a problem hiding this comment.
I think we can update docstring as well.
There was a problem hiding this comment.
sure! Updated in 81f0a82
StrikerRUS
reviewed
Aug 18, 2021
Co-authored-by: Nikita Titov <nekit94-08@mail.ru>
|
This pull request has been automatically locked since there has not been any recent activity since it was closed. To start a new related discussion, open a new issue at https://github.com/microsoft/LightGBM/issues including a reference to this. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Adds type hints to code in
docs/conf.py, as part of #3756.Notes for Reviewers
#3756 has been open for about 8 months now, so I think it's ok for maintainers to start picking up the work to finish it and not wait any longer for outside contributors to find it from searches for
good first issue.Better type hints will improve the ability of
mypyto catch issues (#3868 ).