rice-solar-physics/ebtelplusplus

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

Offen

#125 geöffnet am 06.09.2025

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Python (7 Forks)auto 404
CIbug?docshelp wanted

Repository-Metriken

Stars
 (13 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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.

Contributor Guide

Research-Richtung
Untersuche, wie Sphinx oder das Dokumentationstool Unit Annotationen von Dataclasses verarbeitet, insbesondere die Änderungen in Python 3.12. Überprüfe die Dokumentationskonfiguration und ob eine benutzerdefinierte Verarbeitung erforderlich ist.
Tech Stack
python
Domain
documentation
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Python
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60