simonsobs / simonsobs/sotodlib
Document envvars relevant to sotodlib function
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 19
- Forks
- 23
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 14
Description
E.g. SOTODLIB_TEST_DISABLE_PLOTS, SOTODLIB_TOD_CACHE, SOTODLIB_SQLITE_TIMEOUT ... some of no docstring exposure, even.
Since these enter at environment level, a single doc page listing them might be good.
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
Search the repository for SOTODLIB_TEST_DISABLE_PLOTS, SOTODLIB_TOD_CACHE, and SOTODLIB_SQLITE_TIMEOUT, then identify other environment variables used by sotodlib functions. Add a documentation page listing each variable and its purpose; the work is done when the relevant environment-level settings are discoverable in one place.
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
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100