Skip to content

DOC: Remove FIXME tags from glossary #31677

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
Jun 29, 2025
Merged

DOC: Remove FIXME tags from glossary #31677

merged 2 commits into from
Jun 29, 2025
+9 −8

Conversation

ShauryaDusht
Copy link
Contributor

Reference Issues/PRs

Fixes #31628

What does this implement/fix? Explain your changes.

This pull request removes four FIXME tags from the Glossary page in the documentation. These tags are not intended for end users and should not appear in user-facing content.

Where relevant:

  • I have moved the FIXME notes into comments to retain context for future contributors.

This helps keep the glossary clean, professional, and user-friendly.

Any other comments?

Let me know if any additional changes are needed.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 29, 2025 •
edited
Loading

✔️ Linting Passed

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

Generated for commit: 7535f78. Link to the linter CI: here

StefanieSenger
StefanieSenger reviewed Jun 29, 2025
View reviewed changes
Copy link
Contributor

@StefanieSenger StefanieSenger left a comment

Choose a reason for hiding this comment

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

That looks good overall, thanks @ShauryaDusht.
Only the one Fixme doesn't render correctly (see my comment).

There is a draft PR addressing the same issue (#31674), that seems to be more about fixing a ModuleNotFoundError. I'm not sure if this was a double effort or if these two can combine each other. In general, if someone has already opened a PR, we encourage contributors to wait a few weeks before taking over a task.

@ShauryaDusht
Copy link
Contributor Author

ShauryaDusht commented Jun 29, 2025 •
edited
Loading

Thanks @StefanieSenger for the review and for pointing out the rendering issue.

I'm not sure if this was a double effort or if these two can combine each other

I simply saw the open issue and thought the linked PR was closed. I didn’t notice it was still in draft. So I aimed to resolve those tags.
There was no coordination effort from my side, but if these two can be combined in any way, I am open to that.

if someone has already opened a PR, we encourage contributors to wait a few weeks before taking over a task.

I wasn’t aware of the guideline to wait before taking over recently worked-on issues. I’ll definitely keep that in mind moving forward.

jeremiedbb
jeremiedbb approved these changes Jun 29, 2025
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. Thanks @ShauryaDusht

@jeremiedbb jeremiedbb merged commit a303122 into scikit-learn:main Jun 29, 2025
36 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@StefanieSenger StefanieSenger StefanieSenger left review comments

@jeremiedbb jeremiedbb jeremiedbb 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.

DOC: Glossary contains several FIXME tags
3 participants
@ShauryaDusht @jeremiedbb @StefanieSenger