Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

DOC fix wrong indentations in the documentation that lead to undesired blockquotes #28107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Jan 13, 2024

Conversation

Charlie-XIAO
Copy link
Contributor

Reference Issues/PRs

None, or maybe #28084.

What does this implement/fix? Explain your changes.

There are many places in the documentation where we use wrong indentation, leading to blockquotes. Since the current theme does not have a background or other visible styling for blockquotes it cannot really be observed, but if we switch to a theme (e.g. pydata-sphinx-theme) that does have a background for blockquotes this would be a problem.

Theoretically the current changes in this PR should not change the look of the current website, but is intended to solve some of the problems that the work proposed in #28084 may encounter.

This is indeed a huge PR with thousands of lines of modification, but it is mostly (if not all) about fixing indentation, so I hope it is not too hard to review.

Copy link

github-actions bot commented Jan 12, 2024

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: 3c2dfff. Link to the linter CI: here

doc/developers/minimal_reproducer.rst Outdated Show resolved Hide resolved
doc/developers/minimal_reproducer.rst Outdated Show resolved Hide resolved
doc/developers/minimal_reproducer.rst Outdated Show resolved Hide resolved
doc/developers/performance.rst Outdated Show resolved Hide resolved
doc/modules/clustering.rst Outdated Show resolved Hide resolved
doc/developers/tips.rst Outdated Show resolved Hide resolved
doc/developers/tips.rst Outdated Show resolved Hide resolved
doc/modules/isotonic.rst Outdated Show resolved Hide resolved
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
doc/tutorial/text_analytics/working_with_text_data.rst Outdated Show resolved Hide resolved
doc/tutorial/text_analytics/working_with_text_data.rst Outdated Show resolved Hide resolved
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Copy link
Member

@glemaitre glemaitre left a comment

Choose a reason for hiding this comment

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

LGTM apart of those glitches.

@Charlie-XIAO
Copy link
Contributor Author

Thanks for the review @glemaitre! Seems that these are mostly caused by me letting VSCode automatically dedent without double checking (shouldn't have been lazy lol). I've applied your suggested changes and will make sure to double check as well.

doc/modules/isotonic.rst Outdated Show resolved Hide resolved
doc/modules/isotonic.rst Outdated Show resolved Hide resolved
@glemaitre
Copy link
Member

Seems that these are mostly caused by me letting VSCode automatically dedent without double checking (shouldn't have been lazy lol)

I got trapped as well with this one in the past :)

Charlie-XIAO and others added 2 commits January 13, 2024 23:04
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@glemaitre glemaitre merged commit 198908b into scikit-learn:main Jan 13, 2024
@glemaitre
Copy link
Member

Merging. I think it would help for the website issue.

@Charlie-XIAO
Copy link
Contributor Author

Thanks so much! It definitely would.

@Charlie-XIAO Charlie-XIAO deleted the doc-fix-blkqt branch January 13, 2024 17:46
jeremiedbb pushed a commit to jeremiedbb/scikit-learn that referenced this pull request Jan 17, 2024
…d blockquotes (scikit-learn#28107)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
jeremiedbb pushed a commit that referenced this pull request Jan 17, 2024
…d blockquotes (#28107)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
glemaitre added a commit to glemaitre/scikit-learn that referenced this pull request Feb 10, 2024
…d blockquotes (scikit-learn#28107)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.