[Task] Improve comments in the final XML files generated by tutorials
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- xml
- Área
- documentation
Línea de trabajo
Localiza los archivos XML finales publicados para cada tutorial y compáralos con las fuentes de los tutoriales que definen su estructura. Añade comentarios que expliquen el contexto y las decisiones estructurales; después, verifica que los comentarios reflejen fielmente los tutoriales y que todos los ejemplos XML finales sigan siendo válidos.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
What is this task about?
We publish XML files that represent the end state of each tutorial. Those files don't provide any context for why the file is structured the way it is, where that context is defined by the tutorials themselves.
Why is this task needed?
Some users don't go through the tutorials so don't have the context, and may be confused by the examples.
How can this issue be closed?
Add comments to the XML files that provide context and describe some of the reasons that the file is structured as it is including various choices.
- Lenguaje dominante
- Python
- Estrellas
- 8
- Forks
- 33
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
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.
Más de cyclus/cyclus.github.com
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
cyclus/cyclus.github.com#454 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 64/100
cyclus/cyclus.github.com#453 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 25/100
cyclus/cyclus.github.com#448 · 1 comentario ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
cyclus/cyclus.github.com#445 ·
-
[Task] Update tutorial files in Zenodo ObjectQuizá libre de nuevo @connor-welch la tomó hace 269 días y no hay ningún pull request abierto. Abierto0 - Backlog
cyclus/cyclus.github.com#441 · 3 comentarios · 1 asignado ·
Todos los issues de cyclus/cyclus.github.com
Issues similares
-
effort: low prio: low ready
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
digitalfabrik/integreat-cms#4616 ·
Los mantenedores suelen responder en 5 días
-
bug difficulty:2 good first issue help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
MakazhanAlpamys/Soup#1865 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
FinanceFlash/unvibecode#233 ·
Los mantenedores suelen responder en 1 día
-
area: agents area: docs good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
openapi/gknowledge#23 ·
-
useless-suppression reported for deprecated-* messages that should be exemptPosiblemente ocupada @adityasinha-ghub la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
pylint-dev/pylint#11656 ·
Los mantenedores suelen responder en 1 día