scverse / scverse/SnapATAC2

hard to understand about the description in filter features.

Open
#290 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
323
Forks
43
PR merge metrics
No merged PRs in 30d

Description

Hi Kai,

Here is the description of filter features:

If inplace = False, return a boolean index mask that does filtering, where True means that the feature is kept, False means the feature is removed. Otherwise, store this index mask directly to .var['selected'].

What's the meaning of "Otherwise" here? inplace should only be True or False, right?

Thanks!
Songpeng

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Review the filter feature description quoted in the issue and locate the corresponding Python API documentation. Clarify what “Otherwise” refers to when inplace is a boolean, then verify that the revised wording accurately distinguishes the two documented behaviors.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.