8000 DOC Fix the formatting for environment variables in docs by ogrisel · Pull Request #22833 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

DOC Fix the formatting for environment variables in docs #22833

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Mar 15, 2022
Merged

DOC Fix the formatting for environment variables in docs #22833

merged 2 commits into from
Mar 15, 2022

Conversation

ogrisel
Copy link
Member
@ogrisel ogrisel commented Mar 14, 2022

I noticed that is was unreadable when working on #22749.

  • before:

image

  • after:

image

In addition to making the potentially long variable names readable, it also makes it possible to do a direct link to the documentation of a specific variable as done in the second commit for the sklearn/tests/random_seed.py file.

thomasjpfan
thomasjpfan reviewed Mar 14, 2022
View reviewed changes
Copy link
Member
@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

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

Thanks for the improvement! I agree this PR makes the text much more readable.

@jeremiedbb
Copy link
Member

I agree it's undoubtly better, but I now find hard to distinguish sections. Could we add an item indicator (bullet, dash, ...) ? Maybe not a title but plain text in bold would be more visible ?

@ogrisel
Copy link
Member Author
ogrisel commented Mar 14, 2022 •
edited
Loading

Could we add an item indicator (bullet, dash, ...)

If we use an item list instead of subsection headers we loose the ability to deep-link. Or we could use item lists + manual refs only for the items we want to link to...

But I kind of prefer the simplicity and systematicity of linkable section headers.

jeremiedbb
jeremiedbb approved these changes Mar 14, 2022
View reviewed changes
Copy link
Member
@jeremiedbb jeremiedbb left a comment

Choose a reason for hiding this comment

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

LGTM

thomasjpfan
thomasjpfan approved these changes Mar 15, 2022
View reviewed changes
Copy link
Member
@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

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

LGTM

@thomasjpfan thomasjpfan changed the title DOC fix the formatting of the documentation for environment variables DOC Fix the formatting for environment variables in docs Mar 15, 2022
@thomasjpfan thomasjpfan merged commit dd1b8c3 into scikit-learn:main Mar 15, 2022
@ogrisel ogrisel deleted the format-env-variables branch March 15, 2022 14:26
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Apr 6, 2022
@ogrisel @glemaitre
DOC Fix the formatting for environment variables in docs (scikit-lear…
1797108 
…n#22833)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thomasjpfan thomasjpfan thomasjpfan approved these changes

@jeremiedbb jeremiedbb jeremiedbb approved these changes

Assignees
No one assigned
Labels
Documentation No Changelog Needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ogrisel @thomasjpfan
0