New function: `cf.cell_overlaps`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 150
- Forks
- 23
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 2
Description
The current cf.cellwi(start, end) only matches cells that lie completely with the closed range [start, end].
Sometimes we would like to match cells that merely overlap the range.
I propose a new function cf.cell_overlaps(start, end) that does just this. It will be a constructor function for <CF Query: [upper_bounds(ge start) & lower_bounds(le end)]>
(Compare this with cf.cellwi, which is a constructor function for <CF Query: [lower_bounds(ge start) & upper_bounds(le end)]>)
The docstrings for the various Query constructor functions could also be improved to more accurately reflect what they do!
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 cf.cellwi and the Query constructor functions, then compare their bounds semantics with the proposed cf.cell_overlaps(start, end). Add the new constructor and update the relevant Query constructor docstrings; done means overlap queries match cells intersecting the closed range and the documentation accurately describes each constructor.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100