Skip to content
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

[DOC] format docstrings in feature_selection.py correctly #5994

Merged
merged 4 commits into from
Feb 25, 2024

Conversation

oleeviyababu
Copy link
Contributor

@oleeviyababu oleeviyababu commented Feb 24, 2024

The bullet point for the " feature-importance" is not properly rendered. I have added blank line before and after the bullet point list.

Reference Issues/PRs

Fixes #5993

What does this implement/fix? Explain your changes.

The bullet point for the " feature-importance" in feature_selection.py is not properly rendered. I have added blank line before and after the bullet point list.

Does your contribution introduce a new dependency? If yes, which one?

No

What should a reviewer concentrate their feedback on?

Did you add any tests for the change?

Any other comments?

No

PR checklist

For all contributions
  • I've added myself to the list of contributors with any new badges I've earned :-)
    How to: add yourself to the all-contributors file in the sktime root directory (not the CONTRIBUTORS.md). Common badges: code - fixing a bug, or adding code logic. doc - writing or improving documentation or docstrings. bug - reporting or diagnosing a bug (get this plus code if you also fixed the bug in the PR).maintenance - CI, test framework, release.
    See here for full badge reference
  • Optionally, I've added myself and possibly others to the CODEOWNERS file - do this if you want to become the owner or maintainer of an estimator you added.
    See here for further details on the algorithm maintainer role.
  • The PR title starts with either [ENH], [MNT], [DOC], or [BUG]. [BUG] - bugfix, [MNT] - CI, test framework, [ENH] - adding or improving code, [DOC] - writing or improving documentation or docstrings.
For new estimators
  • I've added the estimator to the API reference - in docs/source/api_reference/taskname.rst, follow the pattern.
  • I've added one or more illustrative usage examples to the docstring, in a pydocstyle compliant Examples section.
  • If the estimator relies on a soft dependency, I've set the python_dependencies tag and ensured
    dependency isolation, see the estimator dependencies guide.

The bullet point for the " feature-importance" is not properly rendered. I have added blank line before and after the bullet point list.
@fkiraly fkiraly changed the title Update feature_selection.py [DOC] format docstrings in feature_selection.py correctly Feb 24, 2024
@fkiraly
Copy link
Collaborator

fkiraly commented Feb 24, 2024

FYI, your changes fail the code formatting checks, due to trailing whitespaces.

Here's a guide on how to set up automatic code formatting locally for you:
https://www.sktime.net/en/stable/developer_guide/coding_standards.html

@yarnabrina yarnabrina self-requested a review February 24, 2024 14:22
@yarnabrina
Copy link
Collaborator

I didn't notice, not really readable from UI. Withdrawing approval, but this should be very simple to fix.

@fkiraly fkiraly merged commit 7574658 into sktime:main Feb 25, 2024
54 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Bullet point not rendered properly on feature_selection.py
3 participants