rice-solar-physics/ebtelplusplus

API reference for unit annotations on dataclasses (e.g. `EbtelResult`) do not render nicely

Aperta

#125 aperta il 6 set 2025

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Python (7 fork)auto 404
CIbug?docshelp wanted

Metriche repository

Star
 (13 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

The way dataclasses handle type/unit annotations must have changed in Python 3.12 because the API documentation no longer renders the unit annotations correctly, e.g. https://ebtelplusplus.readthedocs.io/en/latest/api/ebtelplusplus.EbtelResult.html#ebtelplusplus.EbtelResult.tr_corona_radiative_loss_ratio. Furthermore, the docs build on GitHub Actions is now failing because of a warning about an unfound reference for u.dimensionless_unscaled.

This should be addressed before a new release is cut.

Guida contributor

Direzione di ricerca
Indaga su come Sphinx o lo strumento di documentazione elabora le annotazioni delle unità delle dataclass, concentrandoti in particolare sui cambiamenti in Python 3.12. Controlla la configurazione della documentazione e verifica se è necessaria un'elaborazione personalizzata.
Tech stack
python
Dominio
documentation
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60