simonsobs / simonsobs/sotodlib
Small issue: sotodlib.coords.demod.make_map has inconsistent docstring and function arguments
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 19
- Forks
- 23
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 14
Description
Specifically, sotodlib.coords.demod.make_map says it can take a size argument, but source code doesn't take that as an arg.
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 in sotodlib.coords.demod.make_map and compare its docstring with the function signature. Update the documentation so it matches the supported arguments, then verify the docstring no longer advertises size.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100