Type or doc improvement?

Open
#13,689 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start at preprocessing.ICA.score_sources in the linked API documentation and inspect its l_freq and h_freq parameter definitions. Update the type annotations and parameter documentation so their optional float defaults are described consistently, then run the relevant existing tests or documentation checks.

Written by the indexing model from the issue text.

Description

DOC
Proposed documentation enhancement

preprocessing.ICA.score_sources's - l_freq and h_freq defaults to None but docs says it is float.

Shall we improve types and specify the same in the parameter docstring?

it'd just be small change like:
l_freq: float | None = None,

Dominant language
Python
Stars
3.5k
Forks
1.6k
Avg merge
1d 6h
Merged PRs (30d)
100

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from mne-tools/mne-python

All issues in mne-tools/mne-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.