8000 DOC Update documentation: Communication section improvements by adlina1 · Pull Request #31420 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]

Skip to content

DOC Update documentation: Communication section improvements #31420

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 1 commit into from
May 26, 2025

Conversation

adlina1
Copy link
Contributor
@adlina1 adlina1 commented May 23, 2025

Reference Issues/PRs

What does this implement/fix? Explain your changes.

Reorganize Communication section for better usability:
-> Group communication channels by purpose (Main Channels, Getting Help & Support, Social Media Platforms, Additional Resources)
-> Improve readability and help users quickly find the right channel for their needs

Any other comments?

Copy link

✔️ Linting Passed

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

Generated for commit: 9a36ee3. Link to the linter CI: here

Copy link
Contributor
@StefanieSenger StefanieSenger left a comment

Choose a reason for hiding this comment

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

That's a nice improvement. Thank you, @adlina1!

I've only got a little nit comment on the length of the subheading marker.
And it would be great if you could add a "DOC" in front of your PR title.

For the second reviewer: I have checked that

  • all the links are the same
  • that ------- --> ~~~~~ --> ^^^^^ is the common order to mark headings in rst files
  • build a preview with python -m docutils.writers.html5_polyglot README.rst > preview.html and checked that everything looks fine (it does)

Comment on lines +186 to +187
Developer & Support
^^^^^^^^^^^^^^^^^^^^^^
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: These should have the same length.

Suggested change
Developer & Support
^^^^^^^^^^^^^^^^^^^^^^
Developer & Support
^^^^^^^^^^^^^^^^^^^

@StefanieSenger StefanieSenger added Documentation Quick Review For PRs that are quick to review labels May 24, 2025
@adlina1 adlina1 changed the title Update documentation: Communication section improvements DOC Update documentation: Communication section improvements May 24, 2025
Copy link
Member
@lucyleeow lucyleeow left a comment

Choose a reason for hiding this comment

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

LGTM thanks!

@lucyleeow lucyleeow merged commit 27baebc into scikit-learn:main May 26, 2025
48 checks passed
jeremiedbb pushed a commit to jeremiedbb/scikit-learn that referenced this pull request May 30, 2025
elhambbi pushed a commit to elhambbi/scikit-learn that referenced this pull request Jun 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Quick Review For PRs that are quick to review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0