PolicyEngine / PolicyEngine/python-package-docs

Update docs away from split policyengine-us-data state H5 example

Offen
#2 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
JavaScript
Sterne
0
Forks
0
Ø Merge
20 Min.
Gemergte PRs (30 T.)
1

Beschreibung

PolicyEngine/populace#237 removed release generation for one-file-per-state and one-file-per-district artifacts. The replacement path is the single certified Populace national H5 plus the standard region/scoping machinery in policyengine.py, not direct hf://policyengine/policyengine-us-data/states/... or districts/... files.

GitHub code search still finds split-H5 references in this repo:

  • src/app/page.jsx

Migration checklist:

  • Stop constructing or documenting policyengine-us-data/states/*.h5 and policyengine-us-data/districts/*.h5 dataset URIs.
  • Use the certified Populace default dataset through policyengine.py, with region filters/scoping for state and congressional-district analyses.
  • Add or update a regression test so future state/CD runs do not depend on split regional H5 files.
  • Keep historical/generated output unchanged unless it is actively used by the app or docs.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne in src/app/page.jsx und prüfe, wie dort URIs für H5 auf Bundesstaaten- oder Kongresswahlbezirksebene erstellt oder dokumentiert werden. Lies den Bereichs-/Scoping-Pfad in policyengine.py und füge anschließend einen Regressionstest für Läufe auf Bundesstaaten- und Kongresswahlbezirksebene hinzu oder aktualisiere ihn. Erledigt ist die Aufgabe, wenn aktive Verweise in der App oder Dokumentation den zertifizierten nationalen Populace-Datensatz statt aufgeteilte regionale H5-Dateien verwenden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
documentation, testing, web-dev
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
67/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.