Parameter metadata for the keywords of registered recipe types

Chiusa
  • Qualcosa non va?
#409 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Una pull request collegata è già stata integrata.

  • #451 di @jtravs — integrata

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
22/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
python
Ambito
cli

Direzione di ricerca

Start with the registered types in src/solprop/recipe/registry.py (the Factory around line 140) and the existing route metadata in solprop.recipe.metadata, which the S9 consistency tests exercise. Add a summary, level, default, unit, display unit and manual anchor for each keyword of the 24 + 16 registered types beside their factories, then extend the S9 tests to cover them. Done when every registered keyword has an entry and those tests pass.

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

Descrizione

area: gui area: interfaces enhancement priority: medium

What is missing

SEP 41's parameter metadata (S9, solprop.recipe.metadata) describes every keyword of the gnlse, capillary and waveguide routes and the execution settings. Each entry gives the form, unit, display unit, level, group, summary, default or resolver, and manual anchor. A registered type (Factory) carries only the units of its keywords. This covers GaussianPulse, the grids, PressureGradient, profiles, MaterialSelection, the spatial grids, SpatialPulse, SpatialMedium, the responses, SpatialAbsorber and the rest of the 24 + 16 registered types.

Why it matters

A front end builds its forms, tooltips and newcomer/advanced levels from this metadata, so that it holds no copy of solprop's defaults or wording. Every table of a recipe has none of it today: a second pulse, a pressure gradient, a profile, and the whole setup of the radial, free and planar routes, whose [build] is entirely tables. A script user reading solprop check messages gets the same gap.

Context

  • SEP 41 phase 1 and phase 4 (free-space half) reports, PR #376.
  • The front end's design, section 12.1 and section 21 (docs/dev/gui/design.md), where this is P2. Needed by its milestones M3 (guided routes) and M5 (free space).

To do

  • Give each registered type's keywords the same entry as a route keyword (summary, level, default, range where there is one, display unit, manual anchor), defined beside the factory.
  • Hold them to the target signatures and the manual's headings with the tests that hold S9's.
  • Expose them through the same public call as the route metadata.

Done when

Every keyword of every registered type has an entry, and the existing S9 consistency tests cover them.

Lingua principale
Python
Stelle
3
Fork
3
Merge medio
6h 29m
PR unite (30g)
119

Preparare l'ambiente

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 LupoLab/solprop

Tutte le issue di LupoLab/solprop

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.