rice-solar-physics/ebtelplusplus

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

Ouverte

#125 ouverte le 6 sept. 2025

Voir sur GitHub
 (1 commentaire) (0 réaction) (0 personne assignée)Python (7 forks)auto 404
CIbug?docshelp wanted

Métriques du dépôt

Stars
 (13 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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.

Guide contributeur

Direction de recherche
Examinez comment Sphinx ou l'outil de documentation traite les annotations d'unités des dataclasses, en vous concentrant particulièrement sur les changements dans Python 3.12. Vérifiez la configuration de la documentation et voyez si un traitement personnalisé est nécessaire.
Stack technique
python
Domaine
documentation
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Python
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60