simonsobs / simonsobs/sotodlib
Documentation updates
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 19
- Forks
- 23
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 14
Description
We should update the documentation in light of the package reorganization and after #58 is done, since that will likely change the way that the hardware model is simulated and loaded / dumped.
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
No documentation files or tests are named. Review the package reorganization and issue #58 first, then identify the documentation affected by the hardware model simulation and loading/dumping changes; the work is done when those docs accurately describe the reorganized package and updated behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100