ENH: don't hide constraints or optional arguments in *args/**kwargs/*constraints etc
- Dominant language
- Python
- Stars
- 88
- Forks
- 64
- Avg merge
- 38m
- Merged PRs (30d)
- 1
Description
While their usage seems convenient at first, at the end of the day there are a lot of issues with hiding the details rather then be explicit in an API signature. Just a few of the issues:
* they can swallow arguments without being actually used
* absolute disaster for user facing documentation ( https://github.com/astropy/pyvo/issues/215, but there should be other issues about it, too)
* not easy to track the completeness of options, or do any sanity checks (e.g. https://github.com/astropy/pyvo/pull/426#issuecomment-1439747933)
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing the issue examples, the linked pyvo issue #215, and the discussion in pyvo pull request #426. No repository files, tests, or entry points are named, and the scope of the affected APIs is not defined; completion would mean replacing hidden arguments and constraints with explicit API signatures and keeping their documentation complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, documentation
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100