RosettaCommons / RosettaCommons/atomworks
Expose parser defaults as direct arguments
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 446
- Forks
- 52
- PR merge metrics
- No merged PRs in 30d
Description
Context: https://github.com/RosettaCommons/atomworks/pull/22#discussion_r2342450294
Request: Expose the default arguments as direct parameters to the function so they are visible in IDE signatures and notebooks.
Scope ideas:
- Promote existing default kwargs to explicit parameters.
- Keep backward compatibility for current call sites.
- Update docs and type hints.
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 with the parser function discussed in pull request #22, especially discussion comment 2342450294, and inspect its current default kwargs, call sites, documentation, and type hints. Done means the defaults appear as explicit signature parameters while existing call sites remain compatible and the related docs and annotations are updated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, developer-experience, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100