labthings / labthings/labthings-fastapi
Explain how `Blob` data is managed beter
Open
Nobody has claimed this yet.
documentation
enhancement
- Dominant language
- Python
- Stars
- 9
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
The current documentation on Blob isn't as clear as it could be regarding when data gets copied (and various other internal mechanisms). Some thought should be applied to explaining this better.
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 by locating the current Blob documentation and reviewing how it describes data copying and other internal mechanisms. Clarify the explanation of when Blob data is copied and document the relevant mechanisms; the work is done when these behaviors are understandable from the documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100