Improve tutorials

Abierto
#264 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
20/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
python

Línea de trabajo

The issue does not name tutorial files or tests. Start by locating the tutorials and reading the code behind theory creation for CT14LLO, then trace the import complication mentioned in the issue. Done means the tutorials are understandable and their underlying code is improved; the issue gives no specific acceptance criteria.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

documentation good first issue

This has been addressed in https://github.com/NNPDF/eko/pull/242/commits/30d418da1aedec94185b7fbd66f9fbb86179565e and https://github.com/NNPDF/eko/pull/242/commits/940b3c3e9c44e86f25768a099ecaae5686ab4250 to the extent that they are running again ... however, this is not sufficient, since they are by now quite incomprehensible as we have an import complication in game that is never explained. We agree, we want this feature, but the user experience clearly suffers (consider e.g. the theory creation for CT14LLO). Since I don't know what to write I'll leave the pleasure to you @AleCandido.

Originally posted by @felixhekhorn in https://github.com/NNPDF/eko/issues/242#issuecomment-1542483744

Tutorials are for sure relevant, but currently not the main priority.

As discussed with @felixhekhorn, I'd try to improve their quality by improving the underlying code as well, not just adding sugar for users.

If we'll eventually still need some UX improvements, we will consider adding it after internals improvement and stabilization.

Lenguaje dominante
Python
Estrellas
13
Forks
9
Merge medio
6 d 16 h
PR fusionados (30 d)
3

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de NNPDF/eko

Todos los issues de NNPDF/eko

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.