fsspec / fsspec/filesystem_spec
docs overhaul
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.4k
- Forks
- 490
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 38
Description
This is long overdue, but the ever-extending list of "features" should be replaced by a general docs rewrite, with a focus on end-user operations and examples (e.g., https://github.com/RaRe-Technologies/smart_open/issues/579#issuecomment-775408020 ). All help appreciated! It is to be expected that going through this process will also help to fill out the API with convenience funcitons.
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 reviewing the existing documentation and the ever-extending feature list, then read the linked smart_open discussion for context. Done means a general documentation rewrite focused on end-user operations and examples, with any resulting API convenience functions treated as follow-up work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100