Skip to content
This repository has been archived by the owner on Dec 20, 2024. It is now read-only.

ENH: Outsource data filtering from estimator into its own module #207

Merged
merged 3 commits into from
Jun 10, 2024

Conversation

oesteban
Copy link
Member

This is the first part of #116 sequels.

@oesteban oesteban force-pushed the enh/start-filtering-module branch from e02f5e0 to d6bfd69 Compare June 10, 2024 15:22
@oesteban oesteban requested review from effigies and jhlegarreta June 10, 2024 15:23
effigies
effigies previously approved these changes Jun 10, 2024
Copy link
Member

@effigies effigies left a comment

Choose a reason for hiding this comment

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

Looks good. I don't understand the sphinx warning:

The sphinx warning seems to be sphinx-doc/sphinx#8088, which was fixed by sphinx-doc/sphinx#8095.

Didn't dig much, I could be way off on that.

@oesteban oesteban merged commit c09cac4 into main Jun 10, 2024
7 checks passed
@oesteban oesteban deleted the enh/start-filtering-module branch June 10, 2024 16:55
Copy link
Collaborator

@jhlegarreta jhlegarreta left a comment

Choose a reason for hiding this comment

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

Sorry, I know I am late.

I left an inline comment. I can push a patch set if we agree that the comment is relevant.

----------
data : :obj:`~numpy.ndarray`
The input n-dimensional data array.
p_min : :obj:`float`, optional (default=35)
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would not put the defaults in the docstrings: if for whatever reason they are changed in the method signature, there is a risk of not updating the docstrings. I've seen this happen in other projects, frequently.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, sounds reasonable. Please patch away :)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants