8000 DOC Make release highlights the first gallery section by thomasjpfan · Pull Request #16952 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

DOC Make release highlights the first gallery section #16952

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 11 commits into from
Apr 27, 2020
Merged

DOC Make release highlights the first gallery section #16952

merged 11 commits into from
Apr 27, 2020

Conversation

thomasjpfan
Copy link
Member
@thomasjpfan thomasjpfan commented Apr 17, 2020 •
edited
Loading

Reference Issues/PRs

Partially addresses #16951

What does this implement/fix? Explain your changes.

Moves highlights up and moves misc into its own section.

@NicolasHug
Copy link
Member

It's unfortunate but I feel like General isn't a representative name of this section.

Isotonic Regression, Johnson-Lindenstrauss bound or KernelRidge vs SVR are definitely not "general" examples.

Slightly related is #16601

@thomasjpfan
Copy link
Member Author

I'm thinking of moving these into a Misc section, and then moving "release highlights" to the top.

@thomasjpfan
Copy link
Member Author

Or just move "release highlights to the top" so that Miscellaneous is the first.

@thomasjpfan thomasjpfan changed the title DOC Renames misc section to genearl section in examples DOC Moves example highlights up and moves misc into its own section Apr 18, 2020
NicolasHug
NicolasHug approved these changes Apr 24, 2020
View reviewed changes
Copy link
Member
@NicolasHug NicolasHug left a comment

Choose a reason for hiding this comment

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

I think it looks better like this as well

Might become problematic if we decide not to include the highlights there anymore but oh well

examples/miscellaneous/plot_johnson_lindenstrauss_bound.py
@@ -8,7 +8,8 @@
dataset can be randomly projected into a lower dimensional Euclidean
space while controlling the distortion in the pairwise distances.

.. _`Johnson-Lindenstrauss lemma`: https://en.wikipedia.org/wiki/Johnson%E2%80%93Lindenstrauss_lemma
.. _`Johnson-Lindenstrauss lemma`: https://en.wikipedia.org/wiki/\
Copy link
Member

Choose a reason for hiding this comment

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

Did this raise a warning?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yea a flake8 warning because I moved it.

doc/conf.py

# Forces Release Highlights to the top
if os.path.basename(src_path) == "release_highlights":
return "0"
Copy link
Member

Choose a reason for hiding this comment

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

lol

@thomasjpfan
Copy link
Member Author

Links had to be updated. Looking into what the issues are now.

@NicolasHug NicolasHug added this to the 0.23 milestone Apr 27, 2020
jnothman
jnothman approved these changes Apr 27, 2020
View reviewed changes
Copy link
Member
@jnothman jnothman left a comment

Choose a reason for hiding this comment

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

Really, we should have highlights separately from all the other examples... and the others should just have tags rather than directories to filter them by. That way moving them between directories will not change their URLs, while they could appear in multiple categories.

But I'm happy with this solution. Thanks @thomasjpfan

@NicolasHug NicolasHug changed the title DOC Moves example highlights up and moves misc into its own section DOC Make release highlights the first gallery section Apr 27, 2020
@NicolasHug NicolasHug merged commit 91e9427 into scikit-learn:master Apr 27, 2020
@NicolasHug
Copy link
Member

Thanks @thomasjpfan

gio8tisu pushed a commit to gio8tisu/scikit-learn that referenced this pull request May 15, 2020
@thomasjpfan @gio8tisu
DOC Make release highlights the first gallery section (scikit-learn#1…
5a616ab 
…6952)
@chetak123
Copy link

is the issue still open ? , i am a beginner and wan to make my first contributions , if i can get any help from your side i would be very grateful.

viclafargue pushed a commit to viclafargue/scikit-learn that referenced this pull request Jun 26, 2020
@thomasjpfan @viclafargue
DOC Make release highlights the first gallery section (scikit-learn#1…
64a5c4d 
…6952)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jnothman jnothman jnothman approved these changes

@NicolasHug NicolasHug NicolasHug approved these changes

Assignees
No one assigned
Labels
module:inspection
Projects
None yet
Milestone
0.23
Development

Successfully merging this pull request may close these issues.
4 participants
@thomasjpfan @NicolasHug @chetak123 @jnothman
0