OpenFreeEnergy / OpenFreeEnergy/ExampleNotebooks
should we still reference Perses in showcase notebook?
Nessuno ha ancora preso questa issue.
- Lingua principale
- Jupyter Notebook
- Stelle
- 70
- Fork
- 15
- Merge medio
- 10h 42m
- PR unite (30g)
- 2
Descrizione
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.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Apri il notebook showcase e trova i riferimenti che descrivono il comportamento come «simile a Perses». Leggi la spiegazione circostante e rivedi o rimuovi tali riferimenti, in modo che un nuovo utente non venga distratto dallo stato di sviluppo di Perses; il lavoro è completato quando la formulazione del notebook è chiara senza questa confusione contestuale.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- jupyter-notebook
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 48/100