labthings / labthings/labthings-fastapi
Clarification of Readable/Observable/Writable for Properties/Settings
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 9
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
On merging #110, there was still some discussion RE readable/writeable/observable attributed of properties. These should be better documented and some TODOs relating to them removed from the codebase.
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
Review the discussion in #110 to determine the intended meanings of readable, writable, and observable for properties and settings. Search the codebase for the related TODOs and document the agreed behavior; done means the relevant documentation is clearer and those TODOs have been removed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fastapi, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100