fsspec / fsspec/filesystem_spec
DOC: add basic usage of filesystem
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.4k
- Forks
- 490
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 38
Description
Would it be valuable if basic usage documentation was extended with methods to navigate and check a directory? Think of methods like ls, glob, info (and more) and also how we can use the filter argument.
If it is already documented somewhere and I missed it, feel free to close this issue.
btw, I am willing to make a PR to add this to the documentation.
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 by locating the basic usage documentation and checking whether filesystem navigation and inspection methods such as ls, glob, and info are already covered. Review how the filter argument is documented; the work is done when the relevant basic usage guidance explains these methods and filtering clearly.
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
- 35/100