Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC fix grammatical errors in AdaBoost docstrings - #34355

Merged
StefanieSenger merged 8 commits into
scikit-learn:mainfrom
vashita-pandey:doc-fix-adaboost-docstrings
Jun 28, 2026
Merged

DOC fix grammatical errors in AdaBoost docstrings#34355
StefanieSenger merged 8 commits into
scikit-learn:mainfrom
vashita-pandey:doc-fix-adaboost-docstrings

Conversation

@vashita-pandey

@vashita-pandey vashita-pandey commented Jun 21, 2026

Copy link
Copy Markdown
Contributor

Closes #34354

What does this fix?

Fixes several grammatical errors in sklearn/ensemble/_weight_boosting.py:

  1. "The module structure is the following" → "The module structure is as follows"
  2. "Binary classification is a special cases" → "Binary classification is a special case" (fixed in two places)
  3. "outputs is the same of that of" → "outputs are the same as those of"
  4. "An AdaBoost [1] regressor" → "An AdaBoost [1]_ regressor" (missing RST citation underscore)

@vashita-pandey

vashita-pandey commented Jun 21, 2026

Copy link
Copy Markdown
Contributor Author

Closes #34354

@github-actions github-actions Bot added the CI:Linter failure The linter CI is failing on this PR label Jun 21, 2026
@github-actions github-actions Bot removed the CI:Linter failure The linter CI is failing on this PR label Jun 22, 2026
ogrisel
ogrisel reviewed Jun 22, 2026
View reviewed changes

@ogrisel ogrisel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content of the PR does not match the description. There are fixes that are not implemented and there are unneeded changes.

Comment thread sklearn/ensemble/_weight_boosting.py
Comment thread sklearn/ensemble/_weight_boosting.py
@vashita-pandey
DOC revert unneeded changes per review feedback
bc287b7
@vashita-pandey
Merge branch 'doc-fix-adaboost-docstrings' of https://github.com/vash…
0d63a6d 
…ita-pandey/scikit-learn into doc-fix-adaboost-docstrings

# Please enter a commit message to explain why this merge is necessary,
# especially if it merges an updated upstream into a topic branch.
#
# Lines starting with '#' will be ignored, and an empty message aborts
# the commit.
AnneBeyer
AnneBeyer suggested changes Jun 23, 2026
View reviewed changes

@AnneBeyer AnneBeyer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also fix the links as mentioned in point 4 of your description (the one for [2] is also not working, see the rendered output here)

Comment thread sklearn/ensemble/_weight_boosting.py Outdated
@AnneBeyer

AnneBeyer commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Thank you for fixing the indentation as well!

One more thing: The link you added to the second reference does not seem to be working. And if you find the correct one, please have a look at the AdaBoostClassifier docstring (or this gist) on how to format the whole entry as a link.

@vashita-pandey

vashita-pandey commented Jun 24, 2026

Copy link
Copy Markdown
Contributor Author

I have made the required changes, kindly check.

AnneBeyer
AnneBeyer approved these changes Jun 25, 2026
View reviewed changes

@AnneBeyer AnneBeyer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @vashita-pandey, LGTM now!
If you mark the PR as ready to review (you might have to mark your other one as draft first), @ogrisel could take another look.

@vashita-pandey
vashita-pandey marked this pull request as ready for review June 25, 2026 12:20
@vashita-pandey

vashita-pandey commented Jun 26, 2026

Copy link
Copy Markdown
Contributor Author

I have changed the status of the PR and made it ready to review.
Thanks

@AnneBeyer AnneBeyer mentioned this pull request Jun 26, 2026
Closed
@StefanieSenger StefanieSenger mentioned this pull request Jun 28, 2026
Closed
StefanieSenger
StefanieSenger approved these changes Jun 28, 2026
View reviewed changes

@StefanieSenger StefanieSenger left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thank you @vashita-pandey.

@StefanieSenger
StefanieSenger merged commit 6c381f0 into scikit-learn:main Jun 28, 2026
38 checks passed
prady0t pushed a commit to prady0t/scikit-learn that referenced this pull request Sep 2, 2026
@vashita-pandey @ogrisel @prady0t
DOC fix grammatical errors in AdaBoost docstrings (scikit-learn#34355)
bc9bfae 
Co-authored-by: Olivier Grisel <[email protected]>
@jeremiedbb jeremiedbb mentioned this pull request Sep 8, 2026
Merged
14 tasks
jeremiedbb pushed a commit to jeremiedbb/scikit-learn that referenced this pull request Sep 9, 2026
@vashita-pandey @ogrisel @jeremiedbb
DOC fix grammatical errors in AdaBoost docstrings (scikit-learn#34355)
f19b55e 
Co-authored-by: Olivier Grisel <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ogrisel ogrisel ogrisel left review comments
@StefanieSenger StefanieSenger StefanieSenger approved these changes
+1 more reviewer
@AnneBeyer AnneBeyer AnneBeyer approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Documentation module:ensemble

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

DOC: fix grammatical errors in AdaBoostClassifier and AdaBoostRegressor docstrings

4 participants

@vashita-pandey @AnneBeyer @ogrisel @StefanieSenger