fsspec / fsspec/filesystem_spec
Rename the first argument to `ReferenceFileSystem`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.4k
- Forks
- 490
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 38
Description
Currently, ReferenceFileSystem takes an argument fo: https://github.com/fsspec/filesystem_spec/blob/6233f315548b512ec379323f762b70764efeb92c/fsspec/implementations/reference.py#L66-L69
It's not clear to me what fo means. I understand that is the dictionary generated by kerchunk. Does that have a concrete name we can use? Does references make sense? That is, the dictionary object with the offset / length references?
Contributor guide
No contributing guide indexed for this repository
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 in fsspec/implementations/reference.py at lines 66-69 and inspect how the fo argument is used. Review the issue's proposed meaning and settle on a clearer name, then update the argument and its references consistently while preserving behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100