OpenFreeEnergy / OpenFreeEnergy/ExampleNotebooks
should we still reference Perses in showcase notebook?
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Jupyter Notebook
- Sterne
- 70
- Forks
- 15
- Ø Merge
- 10 Std. 42 Min.
- Gemergte PRs (30 T.)
- 2
Beschreibung
When I first ran the showcase notebook without any contextual knowledge, I was confused as to why behavior was described as "Perses-like", since the Perses homepage comes with a big "under development" disclaimer.
I now understand that OpenFE borrowed from Perses, but for a new user I think this is more distracting than it is helpful. I suggest we rephrase or remove these references for the sake of clarity.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Öffne das Showcase-Notebook und finde die Verweise, die das Verhalten als „Perses-ähnlich“ beschreiben. Lies die umgebende Erklärung und überarbeite oder entferne diese Verweise, damit ein neuer Benutzer nicht durch den Entwicklungsstatus von Perses abgelenkt wird; als erledigt gilt die Aufgabe, wenn die Formulierung im Notebook ohne diese kontextuelle Verwirrung klar ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- jupyter-notebook
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 48/100