Skip to content

DOC improve contributing docs #29126

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 4 commits into from
May 28, 2024

Conversation

Charlie-XIAO
Copy link
Contributor

This PR does the following:

  • Resolve #29037 (comment), i.e., mentioning where to look at to update the API page in the "contributing docs" secction.
  • Replace [MRG] and [WIP] with "draft PR" and "ready for review". I'm seeing some contributors using the former, but I believe in general we prefer the latter nowadays.
  • Fix bad indentation.
  • Simplify things and adapt to pydata-sphinx-theme and new versions of the doc dependencies.
  • Other minor formatting.

Copy link

github-actions bot commented May 28, 2024

✔️ Linting Passed

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

Generated for commit: 758cc01. Link to the linter CI: here

Copy link
Member

@ogrisel ogrisel left a comment

Choose a reason for hiding this comment

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

Overall LGTM! Thanks for the PR.

Copy link
Member

@adrinjalali adrinjalali left a comment

Choose a reason for hiding this comment

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

Wow. This was long overdue. Thank you very much ❤️

@adrinjalali adrinjalali merged commit 2b0e15a into scikit-learn:main May 28, 2024
30 checks passed
@Charlie-XIAO Charlie-XIAO deleted the contributing-doc branch May 28, 2024 11:08
jeremiedbb pushed a commit to jeremiedbb/scikit-learn that referenced this pull request Jul 2, 2024
@jeremiedbb jeremiedbb mentioned this pull request Jul 2, 2024
11 tasks
jeremiedbb pushed a commit that referenced this pull request Jul 2, 2024
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.

3 participants