Skip to content

DOC Add instructions how to use dropdowns in contributing guide#26636

Merged
glemaitre merged 23 commits intoscikit-learn:mainfrom
ArturoAmorQ:doc_guidelines
Jun 22, 2023
Merged

DOC Add instructions how to use dropdowns in contributing guide#26636
glemaitre merged 23 commits intoscikit-learn:mainfrom
ArturoAmorQ:doc_guidelines

Conversation

@ArturoAmorQ
Copy link
Copy Markdown
Member

@ArturoAmorQ ArturoAmorQ commented Jun 20, 2023

Reference Issues/PRs

Follows #26625.

What does this implement/fix? Explain your changes.

#26625 introduces the use of dropdowns. This PR adds some simple guidelines on the contributing guide on how to use them.

Any other comments?

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jun 20, 2023 •
edited
Loading

✔️ Linting Passed

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

Generated for commit: 185cf45

@adrinjalali
Copy link
Copy Markdown
Member

adrinjalali commented Jun 20, 2023

Merging with main should fix the linter issue.

@ArturoAmorQ ArturoAmorQ mentioned this pull request Jun 21, 2023
Merged
glemaitre
glemaitre approved these changes Jun 21, 2023
View reviewed changes
Copy link
Copy Markdown
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.

A couple of nitpicks.

doc/developers/contributing.rst Outdated
- narrative that is too use-case specific;
- narrative that may only interest users that want to go beyond the pragmatics
of a given tool.

Copy link
Copy Markdown
Member

@glemaitre glemaitre Jun 21, 2023

Choose a reason for hiding this comment

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

We don't have enough spacing between the end of the itemize and the beginning of the paragraph.

Copy link
Copy Markdown
Member Author

@ArturoAmorQ ArturoAmorQ Jun 22, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

I don't know how to add spacing. Seems like a bug to me.

Nevermind.

@ArturoAmorQ @glemaitre
Apply suggestions from code review
cb4c600 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
GaelVaroquaux
GaelVaroquaux approved these changes Jun 21, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@GaelVaroquaux GaelVaroquaux left a comment

Choose a reason for hiding this comment

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

LGTM.

I had a look at the rendered docs, and it looks fine

@GaelVaroquaux
Copy link
Copy Markdown
Member

GaelVaroquaux commented Jun 21, 2023

I few comments from @glemaitre still need to be addressed, in particular "We don't have enough spacing between the end of the itemize and the beginning of the paragraph."

glemaitre
glemaitre reviewed Jun 22, 2023
View reviewed changes
doc/developers/contributing.rst Outdated
* Too much information makes it difficult for users to access to the
content they are interested in. Use dropdowns to hide by default:

- low hierarchy sections such as `Examples`, `References`, `Properties`, etc.
Copy link
Copy Markdown
Member

@glemaitre glemaitre Jun 22, 2023

Choose a reason for hiding this comment

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

After a discussion with @ogrisel that was inline with @GaelVaroquaux, let's not fold Examples. Instead, we should advocate for making sure that the Examples section comes right after the main discussion with the least possible folded section in-between.

Copy link
Copy Markdown
Member Author

@ArturoAmorQ ArturoAmorQ Jun 22, 2023

Choose a reason for hiding this comment

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

Added a small mention on this regard.

@glemaitre glemaitre merged commit 4a2b8c3 into scikit-learn:main Jun 22, 2023
@ArturoAmorQ ArturoAmorQ deleted the doc_guidelines branch June 22, 2023 12:35
@glemaitre
Copy link
Copy Markdown
Member

glemaitre commented Jun 22, 2023

Thanks @ArturoAmorQ

jeremiedbb pushed a commit to jeremiedbb/scikit-learn that referenced this pull request Jun 29, 2023
@ArturoAmorQ @GaelVaroquaux
@glemaitre @jeremiedbb
DOC Add instructions how to use dropdowns in contributing guide (scik…
2447f2f 
…it-learn#26636)

Co-authored-by: Gael Varoquaux <gael.varoquaux@normalesup.org>
Co-authored-by: ArturoAmorQ <arturo.amor-quiroz@polytechnique.edu>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
jeremiedbb pushed a commit that referenced this pull request Jun 29, 2023
@ArturoAmorQ @GaelVaroquaux
@glemaitre @jeremiedbb
DOC Add instructions how to use dropdowns in contributing guide (#26636)
8513f35 
Co-authored-by: Gael Varoquaux <gael.varoquaux@normalesup.org>
Co-authored-by: ArturoAmorQ <arturo.amor-quiroz@polytechnique.edu>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
REDVM pushed a commit to REDVM/scikit-learn that referenced this pull request Nov 16, 2023
@ArturoAmorQ @GaelVaroquaux
@glemaitre @REDVM
DOC Add instructions how to use dropdowns in contributing guide (scik…
1ad2032 
…it-learn#26636)

Co-authored-by: Gael Varoquaux <gael.varoquaux@normalesup.org>
Co-authored-by: ArturoAmorQ <arturo.amor-quiroz@polytechnique.edu>
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

Reviewers

@GaelVaroquaux GaelVaroquaux GaelVaroquaux approved these changes

@glemaitre glemaitre glemaitre approved these changes

Assignees

No one assigned

Labels

Documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@ArturoAmorQ @adrinjalali @GaelVaroquaux @glemaitre