simonsobs / simonsobs/tilemaker
Make catalog description optional
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
Descriptions are optional for maps. They could be for catalogs as well. I didn't want to make this change myself since there is a non-optional argument (console) that follows the description argument, so making description optional would change the function signatures.
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
Locate the catalog function or constructor and compare its description handling with the map implementation. Read how the following console argument is passed, then verify that a catalog can omit description while console behavior and existing calls remain unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100