Adapt default values in docstrings to supported format #268
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
kbattocchi
force-pushed
the
kebatt/sphinx3_2
branch
from
ea6dd01
to
613e26f
Compare
|
Superseded by #663 |
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.
Sphinx 3.2 checks default argument specifications more stringently (see e.g. sphinx-doc/sphinx#8088), so the build was failing with that version of Sphinx. These changes should address the issue, except that our classes that derive from classes in external libraries can still have problems with inherited method docstrings (e.g.
StatsModelsLinearRegression), so we either need to wait for sklearn to update their own classes or for Sphinx to relax the new restrictions.