FEniCS/dolfinx

Restructure demos into more functions where appropriate

Offen

#3.076 geöffnet am 27.02.2024

Auf GitHub ansehenContributor Guide
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (255 Forks)auto 404
demogood first issue

Repository-Metriken

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

Beschreibung

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.

Contributor Guide

Research-Richtung
Untersuchen Sie die C++ und Python Beispiele und identifizieren Sie diejenigen, die übermäßig lang sind. Refactoren Sie sie, indem Sie sie in kleinere Funktionen aufteilen, und stellen Sie sicher, dass die Beispiele ausführbar und verständlich bleiben.
Tech Stack
cpppython
Domain
documentation
Issue Type
Refactoring
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
C++PythonGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80