Consider making EstimateCache an opaque object
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 27
- Forks
- 30
- PR merge metrics
- No merged PRs in 30d
Description
API Quality Request
The EstimateCache class is passed around by the public API, but as far as I can tell it only gets used by internal mechanisms of rmf_task. To reduce the surface area of the public API that we need to maintain stability for, we should consider making EstimateCache an opaque class, similar to CostCalculator.
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 reading rmf_task/include/rmf_task/Estimate.hpp and comparing its EstimateCache declaration with rmf_task/include/rmf_task/CostCalculator.hpp. Trace the public and internal uses of EstimateCache to confirm whether callers depend on its details. Done means the public API exposes it opaquely without breaking the internal mechanisms that use it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100