Deprecate/remove instrument.base.add_function ?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 459
- Forks
- 359
- Avg merge
- 3d 6h
- Merged PRs (30d)
- 73
Description
Possibly related to #345 .
Similar to the add_parameter, the instrument has a method `add_function`. To me the use case of this is very unclear and IMO opinion using regular python methods is preferred over using the add_function method to add a function as a method to an instrument.
Advantages of using regular methods are
- more readable in the code/simpler
- docstring generated are correct
As such I would propose to deprecate the use of the add_function method.
@jenshnielsen @WilliamHPNielsen @sohailc
(also now that Giulio left, who are all the remaining maintainers?)
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 by locating instrument.base.add_function and review the related discussion in issue #345. Determine whether the method should be deprecated or removed, then confirm that the chosen change and its compatibility impact are documented and agreed by maintainers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100