PyAr / tutorial-en-papel

Versión oficial del Tutorial de Python en español con ajustes para facilitar la impresión "en papel"
3 stars 1 forks source link

Review capítulos #25

Open cacrespo opened 2 years ago

cacrespo commented 2 years ago

Voy a leer y revisar cada uno de los capítulos. Si encuentro alguna frase sin sentido o algo que no me cierre lo vamos hablando y llegado el caso creo PR en el repositorio original.

cacrespo commented 2 years ago

1 Abriendo el apetito

image

El primer párrafo que pinté me resulta bastante confuso al leer. Mantendría el tono "rioplatense" ¿?, en vez de "puede escribir un script..." diría "Puedes..." . También mantendría "archivos por lotes" y retocaría un poco para que quede así:

Puedes escribir un script de shell de Unix o archivos por lotes de Windows para algunas de estas tareas. Los scripts de shell son mejores para mover archivos y cambiar datos de texto, pero no son adecuados para juegos o aplicaciones GUI. Podrías escribir un programa C / C ++ / Java, pero llevaría mucho tiempo de desarrollo obtener incluso un primer programa de borrador. Python es más fácil de usar, está disponible en los sistemas operativos Windows, macOS y Unix, y te ayudará a hacer el trabajo más rápidamente. Python es fácil de utilizar y es un verdadero ~siendo un~ lenguaje de programación ~real~ ofreciendo mucha más estructura y soporte para programas grandes que la que ofrecen scripts de shell o archivos por lotes.

El resto lo veo OK.

humitos commented 2 years ago

👍 -este cambio que mencionas, habría que hacerlo directamente sobre la traducción oficial

cacrespo commented 1 year ago

2 Usando el intérprete de Python

Corregí algunas cosas y ya levanté el PR (los voy poniendo en el primer comment del issue).

Hay algunas referencias a otras partes del documento que vamos a tener que borrar. image image

humitos commented 1 year ago

Groso! Estas eran las referencias "muertas" a las que me refería en otro issue.

Estoy pensando si en vez de borrar esos párrafos se podrá hacer que muestre el título del capítulo y una nota de pagina con la URL. Luego voy a probar si puedo.

Creo que eso sería mejor que borrar el texto así el lector sabe dónde ir a buscar ese contenido. ¿Qué opinás?

cacrespo commented 1 year ago

Estoy pensando si en vez de borrar esos párrafos se podrá hacer que muestre el título del capítulo y una nota de pagina con la URL.

Eso sería perfecto! Como opción alternativa y si vemos que no sale nada podría ser una nota por defecto para todos los casos que diga algo del estilo "Consultar en documentación oficial https://docs.python.org/3/".

Yo prefiero, de mejor a peor opción:

humitos commented 1 year ago

Ahí lo hice. Pongo una muestra de cómo quedaría:

Screenshot_2022-11-12_18-00-52

@cacrespo si encontrás más de estos, decime y los voy arreglando 👍🏼

Este es el PR que soluciona lo que encontraste hasta ahora: https://github.com/PyAr/tutorial-en-papel/pull/28


El proceso consiste simplemente en anteponer python: al nombre de la referencia y encerrar la referencia entre \" para que se entienda dónde empieza y dónde termina el nombre. Por ejemplo, en el último caso que comentás, cambié lo siguiente:

@@ -225,7 +224,7 @@ msgstr ""
 #: ../Doc/tutorial/interpreter.rst:118
 msgid "For more on interactive mode, see :ref:`tut-interac`."
 msgstr ""
-"Para más información sobre el modo interactivo, ver :ref:`tut-interac`."
+"Para más información sobre el modo interactivo, ver \":ref:`python:tut-interac`\"."

 #: ../Doc/tutorial/interpreter.rst:124
 msgid "The Interpreter and Its Environment"

Esto por detrás utiliza la extensión de Sphinx llamada intersphinx para buscar en la documentación oficial el título y el link correcto.

cacrespo commented 1 year ago

3 Una introducción informal a Python

El prompt se renderiza mal image

Me llama la atención que en la versión web del tutorial (y en el .po de este capítulo) tenemos este párrafo: image Refiere a una cuestión que no tendría nada que ver con la versión en papel y deberíamos excluir. Cuando hacemos el pdf lo excluye por defecto :open_mouth:

No encontré ninguna directiva ni nada que apunte a no considerar ese párrafo para el pdf. ¿Te pasa lo mismo? ¿o me estoy volviendo loco? Tal vez nos puede ser útil esa funcionalidad.

image image image Para mutable e inmutable la verdad que no sé si vale la pena meterles la nota al pie. La página está bastante cargada de notas y se entiende...

cacrespo commented 1 year ago

4 Más herramientas para control de flujo

El doble signo igual se renderiza de una manera que puede generar confusion. image image

Cuando pasamos comillas dobles se ven como en el PDF. Ocurre lo mismo en el sitio online en la versión en español. Si bien es el mismo signo de puntuación me gustan mucho más las comillas altas. Estoy en dudas si corregirlo acá exclusivamente, dejarlo así o levantar el issue para toda la documentación. ¿Qué decís? image

Referencias rotas: image

cacrespo commented 1 year ago

5 Estructuras de datos

Este párrafo sale en inglés aunque ya tiene la traducción completa en el .po ¿? image

Referencias rotas: image image image image

cacrespo commented 1 year ago

6 Módulos

No entra la salida completa en la hoja. image

Ya lo mencionamos en otro lado, pero definitivamente hay que encontrar el modo en que el código que aparece en el cuerpo del texto tenga un tamaño de fuente más chica. Esto se ve bastante fiero: image

cacrespo commented 1 year ago

7 Entrada y salida

Todo lo que pinté en esta parte lo sacaría. Hace referencia al bloque general de la documentación y además no se entiende muy bien. image image image image image image image image

cacrespo commented 1 year ago

8 Errores y excepciones

image image image image image image image