Skip to content

doc-fix: Fix for text outside of the dropdown and a grammar fix #30116

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 6 commits into from
Oct 21, 2024

Conversation

abhi-jha
Copy link
Contributor

@abhi-jha abhi-jha commented Oct 20, 2024

What does this implement/fix? Explain your changes.

Fixes the Complexity dropdown inside Hessian Eigenmapping section inside Manifold Learning module inside Unsupervised Learning chapter.

Currently the dropdown inside the hessian 2.2.5. Hessian Eigenmapping doesn't have the text as attached below.

Screenshot 2024-10-20 at 4 49 45 PM

https://scikit-learn.org/stable/modules/manifold.html#hessian-eigenmapping

Added a grammar fix as well.

Copy link

github-actions bot commented Oct 20, 2024

✔️ Linting Passed

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

Generated for commit: d382bc5. Link to the linter CI: here

@abhi-jha
Copy link
Contributor Author

I see multiple CI jobs failing. Is there a linting command that I should be using?

@lesteve
Copy link
Member

lesteve commented Oct 21, 2024

The doc failure probably comes from a warning turned into error during the build, from build log:

The following documentation warnings may have been generated by PR #https://github.com/scikit-learn/scikit-learn/pull/30116:
/home/circleci/project/doc/modules/manifold.rst:301: WARNING: Enumerated list ends without a blank line; unexpected unindent.

Maybe you need to align vertically your bullet point 2. content?

You can draw some inspiration from the "Spectral Embedding" section which has a similar dropdown.

You can also build the documentation locally, see doc for more details, and check the rendering.

@abhi-jha
Copy link
Contributor Author

Made some fixes. Looks like the CI is stuck or disappeared?

Comment on lines 301 to 303
:math:`O[D N k^3] + O[N d^6]`. The first term reflects a similar
cost to that of standard LLE. The second term comes from a QR
decomposition of the local hessian estimator.
Copy link
Member

Choose a reason for hiding this comment

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

doc CI is still red as far as I can see, maybe try this (one more space so that **Weight Matrix aligns vertically with the following lines that belong to the same bullet point)?

Suggested change
:math:`O[D N k^3] + O[N d^6]`. The first term reflects a similar
cost to that of standard LLE. The second term comes from a QR
decomposition of the local hessian estimator.
:math:`O[D N k^3] + O[N d^6]`. The first term reflects a similar
cost to that of standard LLE. The second term comes from a QR
decomposition of the local hessian estimator.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The CI was showing me a big circle for a very long time. And most of the icons were blurred for some reason. Made fixes.

Copy link
Member

@lesteve lesteve left a comment

Choose a reason for hiding this comment

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

Thanks, the doc CI is happy now and the rendering looks good, see generated doc.

I have set auto-merge.

@lesteve lesteve enabled auto-merge (squash) October 21, 2024 13:56
@lesteve lesteve disabled auto-merge October 21, 2024 13:56
@lesteve lesteve enabled auto-merge (squash) October 21, 2024 13:57
@lesteve lesteve merged commit 4c78d7c into scikit-learn:main Oct 21, 2024
28 checks passed
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.

2 participants