OpenFreeEnergy / OpenFreeEnergy/ExampleNotebooks
should we still reference Perses in showcase notebook?
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Jupyter Notebook
- Estrellas
- 70
- Forks
- 15
- Merge medio
- 10 h 42 min
- PR fusionados (30 d)
- 2
Descripción
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.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Abre el notebook de showcase y encuentra las referencias que describen el comportamiento como «similar a Perses». Lee la explicación circundante y revisa o elimina esas referencias para que un usuario nuevo no se distraiga por el estado de desarrollo de Perses; se considera completado cuando la redacción del notebook es clara sin esa confusión contextual.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- jupyter-notebook
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 48/100