[1.0.0] Scope freeze: reconcile dark corners

Aperta
#2,930 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Refactoring
Chiarezza
Da chiarire
Stato di attività
Tranquilla
Stack tecnologico
python

Direzione di ricerca

Start with the README feature matrix, xrspatial/init.py, and the stability policy referenced by #2415; then inspect the listed module files and compare their public symbols. Record a decision for each checklist item, update the matrix or public markers accordingly, and complete the LTS and re-sweep bookkeeping.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

1.0.0-tracking scope-freeze

Scope freeze: reconcile dark corners before 1.0.0

1.0.0 freezes the public surface to the README feature matrix. Before the freeze we resolve every function that lives in the code but is not cleanly accounted for in the matrix: either promote it (export from xrspatial/__init__.py and document it in the matrix) or drop it from the public surface (mark private or keep experimental). Each group tracking issue blocks its "Scope frozen" checkbox on the relevant decisions here.

Multispectral indices (in README, not exported) — xrspatial/multispectral.py
  • gci: promote or drop
  • ebbi: promote or drop
  • nbr2: promote or drop
  • true_color: promote or drop
Focal (in README, not exported) — xrspatial/focal.py
  • apply: promote or drop
  • hotspots (Getis-Ord Gi*): promote or drop. Distinct from the exported emerging_hotspots.
  • focal_stats: promote or drop
Experimental — xrspatial/experimental/min_observable_height.py
  • min_observable_height: keep experimental, promote, or drop
Exported but underdocumented in the matrix
  • diagnose (xrspatial/diagnostics.py): document or mark internal
  • hypsometric_integral (xrspatial/zonal.py): document or mark internal
  • suggest_zonal_canvas (xrspatial/zonal.py): document or mark internal
  • clip_polygon (xrspatial/polygon_clip.py): document or mark internal
LTS commitment
  • Declare the xrspatial/__init__.py high-level spellings and the .xrs accessor as LTS. See the stability policy doc and #2415.
Re-sweep currency (process)
  • Approved current models: opus-4.x, gpt-5.5. A sweep field is set to Clear only after a fresh /deep-sweep <module> by a current model finds no new CRITICAL/HIGH. Record Last swept = <model> <date> on the item.
  • One fix per PR for sweep findings.
  • When a newer frontier model ships, add it to the approved list. The "Stale sweeps" board view then surfaces every group whose Last swept predates it, and those re-enter sweeping. A Clear is provisional until re-swept by the newest model.
Lingua principale
Python
Stelle
972
Fork
92
Merge medio
2g 12h
PR unite (30g)
7

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di xarray-contrib/xarray-spatial

Tutte le issue di xarray-contrib/xarray-spatial

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.