Errores en el Manual

Buenas, soy nuevo participando en el foro de pilas, ayer le mostre pilas a mi sobrino y un amigo y la verdad que luego de verlos felices programando me decidi a colaborar con el proyecto.

La cuestion es que dentro de las cosas fundamentales que encontre mientra observaba a mi sobrino aprender pilas, es que es muy necesario que todo el codigo que esta en el manual funcione, y funcione bien. Ya hice push de un error obvio que encontre, pero los otros 2 o 3 errores no son obvios y son bastante dependientes del SO o de alguna libreria, y no se como puedo reportarlos.

Ademas, me plantee que los mas logico seria trabajar test para los diferentes “casos” que se tratan en el manual, de esta manera vamos a estar seguro que todo “Compila”. No se si les parece que esto pueda hacerse o si hay otras cosas en que trabajar primero.

Saludos, Jairo

Hola Jairot!!!, bueno, hablamos un poquito por mail… pero te comento aquí también.

El manual es super importante, si encuentras arreglos para hacer puedes implementarlos directamente y luego hacer un pullrequest. Tanto quiqueporta como yo estamos haciendo las revisiones e integrando en la rama develop de github.

Consultanos cualquier cosa, aún nos falta hacer un tutorial para ayudar a nuevos colaboradores, pero ante cualquier consulta avisanos.

Ah, y bienvenido !!!

Estuve investigando un poco, y con doctests se pueden hacer test que validen que lo que esta escrito en el manual “funciona”(No creo que podamos validar que funcione bien porque el output es visual, pero al menos que no da error)

El problema son dos cosas:

  1. para que doctest detecte el codigo, necesito agregarle los 3 “>>>” del interprete… Es mas o menos complicado esto pero lo puedo ahcer con un script basico yo
  2. lo mas complejo, es que deberiamos empezar a ahcer que cada capitulo de la documentacion sea “Continuado” es decir, que todo el codigo que se pone en un capitulo de la documentacion funcione entre si como un programa. Esto implicaria reformar algunas cosas, pero podemos ir haciendolo de a poco.

Si estan de acuerdo con esto, puedo empezar a hacer el parser del punto 1.

Saludos, Jairo

m… me suena medio complejo del punto 2, ¿como sería?, podemos tomar al menos un capítulo y hacer la prueba ahí, al menos para comenzar. Si funciona si, lo automatizamos de alguna forma.