[MRG] DOC fix some sphinx warnings #11241
Merged
Conversation
This file contains hidden or 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
|
Oh no, I've landed on a numpydoc bug I probably created! |
jnothman
changed the title
jnothman
changed the title
| ---------- | ||
| .. [1] P. J. Rousseeuw. Least median of squares regression. Journal of American | ||
| Statistical Ass., 79:871, 1984. | ||
| .. [2] Johanna Hardin, David M Rocke. The distribution of robust distances. |
There was a problem hiding this comment.
I'm not sure whether it's good to remove references, even if they're not used.
There was a problem hiding this comment.
Oh. I had expected that these would be present in the class docs. Apparently not.
There was a problem hiding this comment.
@VirgileFritsch, it's unclear to the reader what the relevance of these references in plot_robust_vs_empirical_covariance.py is, since they are not cited anywhere. Are these references here, rather than in MinCovDet, because they are the inspiration for the example?
|
The warning diff: diff -d --unchanged-line-format '= %l
' --old-line-format='< %l
' --new-line-format='> %l
' <(curl "https://circleci.com/api/v1.1/project/github/scikit-learn/scikit-learn/24674/output/104/0?file=true" | grep WARNING | sort) <(curl "https://circleci.com/api/v1.1/project/github/scikit-learn/scikit-learn/24739/output/104/0?file=true" | grep WARNING | sort | grep -v 'Could not obtain' | grep -v 'image file not readable') | pbcopyoutput: (There's something quirky going on in diffing a few of the lines that are in both versions) |
TomDLT
approved these changes
Jun 21, 2018
|
I'm going to revert the removal of the references, and merge this. |
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.
While it would be wonderful to enable sphinx-build with
-Wso that we actually find out when a new documentation build warning is created, here are fixes to several of the numerous warnings we currently get.See also #11083 (comment) where I discuss one unresolved set of warnings.
Resolving these one-by-one takes a fair bit of labour and extensive knowledge of sphinx/reST :(
I'll give a list of the removed warnings once Circle completes.