[MRG] Fix typos in datasets documentation#13474
[MRG] Fix typos in datasets documentation#13474qinhanmin2014 merged 3 commits intoscikit-learn:masterfrom
Conversation
Changed spelling and grammar typos on lines 53 (spelling miscellaneous), 174 (Beginning of sentence not capitalized), 264 (grammar implies images not image).
doc/datasets/index.rst
Outdated
| datasets that are challenging to certain algorithms (e.g. centroid-based | ||
| clustering or linear classification), including optional Gaussian noise. | ||
| They are useful for visualisation. produces Gaussian | ||
| They are useful for visualisation. Produces Gaussian |
There was a problem hiding this comment.
this seems strange, maybe ..., and to produce...?
There was a problem hiding this comment.
I agree, but wasn't sure on what the message was trying to convey so I went with the smallest change possible. And to produce would seem to convey the same message and be clearer.
There was a problem hiding this comment.
Only make_circles produces a spherical decision function so the sentence does not apply to both.
How about:
:func:
make_circlesproduces Gaussian data with a spherical decision boundary for binary classification, while :func:make_moonsproduces two interleaving half circles.
There was a problem hiding this comment.
Yeah definitely thought maybe that there might be a different meaning because the sentence seemed to be unfinished. I changed it and changed the formatting by adding backquotes.
:func:
make_circles ... :func:make_moons` ...
This was to match with other references in the documentation, please tell me if that shouldn't be the case in this instance. Thank you
Changed to accurately represent the visualization of :func:make_circles and :func:make_moons
NicolasHug
left a comment
There was a problem hiding this comment.
line length issue, LGTM otherwise!
doc/datasets/index.rst
Outdated
| clustering or linear classification), including optional Gaussian noise. | ||
| They are useful for visualisation. produces Gaussian | ||
| data with a spherical decision boundary for binary classification. | ||
| They are useful for visualisation. :func:`make_circles` produces Gaussian data with a spherical decision boundary for binary classification, while :func:`make_moons` produces two interleaving half circles. |
There was a problem hiding this comment.
please avoid long lines: split this into multiple lines with approximately 80 characters
There was a problem hiding this comment.
Fixed, thanks for the input!
Fixed documentation to not go over 80 characters
qinhanmin2014
left a comment
There was a problem hiding this comment.
LGTM, thanks @christopherchoe
This reverts commit 443d9af.
This reverts commit 443d9af.
Changed spelling and grammar typos on lines 53 (spelling miscellaneous), 174 (Beginning of sentence not capitalized), 264 (grammar implies images not image).
Reference Issues/PRs
What does this implement/fix? Explain your changes.
Any other comments?