Skip to content

DOC: Mark the sentence end in classification_report#16411

Merged
NicolasHug merged 1 commit intoscikit-learn:masterfrom
jhlegarreta:MarkSentenceEndInClassificationReportDocstring
Feb 10, 2020
Merged

DOC: Mark the sentence end in classification_report#16411
NicolasHug merged 1 commit intoscikit-learn:masterfrom
jhlegarreta:MarkSentenceEndInClassificationReportDocstring

Conversation

@jhlegarreta
Copy link
Copy Markdown
Contributor

Mark the sentence end in classification_report method docstring.

Mark the sentence end in `classification_report` method docstring.
@ogrisel
Copy link
Copy Markdown
Member

ogrisel commented Feb 8, 2020

Fine with me but I am not sure we are consistent in our code base. If the de-facto convention is half and half, maybe we should not open individual PRs for each docstring.

@jhlegarreta
Copy link
Copy Markdown
Contributor Author

@ogrisel Thanks for the review. sorry, I did not pretend to address all such occurrences throughout the whole code base; I was reading the documentation on that module and saw that a fair number of docstrings or those that I checked were using that convention.

In any case, I believe that rather than a convention, using punctuation helps to mark the end of the sentence/paragraph in the docstring.

I understand your point and I do share that if this is to be done consistently for the whole code-base, a single PR should address all occurrences.

@NicolasHug NicolasHug changed the title [MRG] DOC: Mark the sentence end in classification_report method docstring DOC: Mark the sentence end in classification_report Feb 10, 2020
@NicolasHug NicolasHug merged commit 09bd9ee into scikit-learn:master Feb 10, 2020
@NicolasHug
Copy link
Copy Markdown
Member

thanks @jhlegarreta

@jhlegarreta jhlegarreta deleted the MarkSentenceEndInClassificationReportDocstring branch February 10, 2020 14:01
thomasjpfan pushed a commit to thomasjpfan/scikit-learn that referenced this pull request Feb 22, 2020
panpiort8 pushed a commit to panpiort8/scikit-learn that referenced this pull request Mar 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants