pysmurf-controller operation method signature overrides missing args
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 17
- Forks
- 20
- Avg merge
- 1h 22m
- Merged PRs (30d)
- 2
Description
The pysmurf-controller's task and process method signature overrides aren't in sync with the actual args/kwargs they take. For instance:
stream(duration=None)
should be:
stream(duration=None, kwargs=None, load_tune=None, stream_type=None, subtype=None, tag=None)
Arguments that are optional should also be marked as such, notably kwargs and load_tune in this example, which don't say 'optional' next to their type.
Contributor guide
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 PysmurfController operation entries in the linked pysmurf-controller API documentation, beginning with stream. Compare each documented task and process signature with the actual arguments and mark optional arguments consistently; done means the documented signatures and optional-argument annotations match the implementation across the agent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100