petercorke / petercorke/robotics-toolbox-python
Connector/backend API polish: addable-object superclass, teach-panel promotion, getframe()
Open
Nobody has claimed this yet.
enhancement
help wanted
- Dominant language
- C++
- Stars
- 3.5k
- Forks
- 624
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 53
Description
Small cluster of backend-API cleanup ideas, migrated from the wiki's Backends page TODO section.
- Objects addable to a backend (robots, shapes, etc.) don't share a common superclass with the abstract methods they need — tidy this up
-
teachis still effectively a private/underscore-prefixed panel feature — promote it to a proper public API - Add a
getframe()method toConnectorto return the current frame as a PIL image, for saving/embedding — needs a design that works across backends (PyPlot, Swift, ...) since none currently implement it
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 inspecting the Connector entry point, the addable backend objects, and the current underscore-prefixed teach panel feature. Compare the PyPlot and Swift backends before deciding how getframe() can return a PIL image across implementations. Done means the shared object API, public teach API, and cross-backend frame API are defined and implemented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- backend-api-design
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100