Specification of files required for `read_10x_mtx`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.6k
- Forks
- 779
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 27
Description
Description
In the docs for scanpy.read_10x_mtx, the mentioned file extensions and files are all uncompressed, e.g., matrix.mtx. However, when specifying a path which does not include the required file the FileNotFoundError calls it matrix.mtx.gz. For consistency, I think it'd be good to use either the compressed or uncompressed format in both cases, i.e., either update the docs or the FileNotFoundError. Otherwise, users might think they might have to compress the file (if there is a small typo in the provided path, for example).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the documentation for scanpy.read_10x_mtx and the code path that raises its FileNotFoundError. Compare the documented filenames with the filenames reported by the error, then make the compressed or uncompressed naming consistent and verify both references agree.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100