FEniCS/dolfinx

Restructure demos into more functions where appropriate

Ouverte

#3 076 ouverte le 27 févr. 2024

Voir sur GitHubGuide contributeur
 (3 commentaires) (0 réaction) (0 personne assignée)C++ (255 forks)auto 404
demogood first issue

Métriques du dépôt

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

Description

Most demos (C++ and Python) have a flat structure. This is fine for simple problems, but I see time and time again that users model their more extensive solvers on the demos and create single function (C++) / flat script (Python) demos that can be many hundreds or thousands of lines.

It would be good to review the structure of demos and refactor with more functions where appropriate. Hopefully users will then model their own codes on the more structured demos.

Guide contributeur

Direction de recherche
Examinez les exemples C++ et Python et identifiez ceux qui sont trop longs. Refactorez en les divisant en fonctions plus petites, en veillant à ce que les exemples restent exécutables et compréhensibles.
Stack technique
cpppython
Domaine
documentation
Type d'issue
Refactorisation
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
C++PythonGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80