NCAS-CMS / NCAS-CMS/cf-python

New mixin method to consolidate normalisation of limits

Open
#926 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

code tidy enhancement
Dominant language
Python
Stars
150
Forks
23
Avg merge
1d 11h
Merged PRs (30d)
2

Description

In some places across the codebase we make use of logic to normalise arguments of bounds or query boundaries to account for a defined cyclic period. There is a decent amount of duplication of this and related logic, so we should think about how to consolidate this all - we are thinking into one new user-facing method.

See https://github.com/NCAS-CMS/cf-python/pull/925#discussion_r2847301405 for initial discussion.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the discussion in pull request #925, then locate the duplicated logic across the codebase that normalises bounds or query boundaries for cyclic periods. Identify the mixin and related call sites involved before deciding on the user-facing method; done means the overlapping logic is consolidated without changing the intended limit behaviour.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.