Skip to content

Commit 4df8b9f

Browse files
committed
Merge remote-tracking branch 'upstream/3.8' into trad-email.generator.po
2 parents f920a1d + c909de1 commit 4df8b9f

File tree

191 files changed

+16313
-4573
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

191 files changed

+16313
-4573
lines changed

.overrides/CONTRIBUTING.rst

+83-56
Original file line numberDiff line numberDiff line change
@@ -4,55 +4,28 @@ Guía para contribuir en la traducción
44
=====================================
55

66
¡Muchas gracias por tu interés en participar de la traducción de la
7-
documentación oficial de Python al Español! Necesitamos *mucho* de tu ayuda
8-
para poder seguir adelante con este proyecto. Te damos la bienvenida y
9-
te agradecemos anticipadamente por tus futuras colaboraciones.
7+
documentación oficial de Python al Español!
108

119
Este es el grupo de trabajo para la traducción de la
1210
documentación oficial de Python al Español, todo el contenido de la traducción
1311
es mantenido por voluntaries que aportan su tiempo y trabajo a la comunidad.
1412

1513
Antes de comenzar tu primera traducción, y que sigas con esta guia de
16-
contribución, queremos señalar algunos lineamientos generales.
17-
18-
- Esta traducción es mantenida por personas de todo el mundo que hablan el
19-
idioma Español. No queremos atarla a ninguna región en particular y creemos
20-
que es un valor extra la diversidad de la misma. Vas a encontrar secciones
21-
con diferentes tonalidades de países, regiones o estilos. Lo único que pedimos
22-
es consistencia dentro de un mismo módulo o sección (es decir no cambiar de
23-
estilo de un párrafo a otro, por ejemplo) y siempre intentar que la persona del
24-
otro lado pueda entender lo que estamos escribiendo (no usar lunfardo o
25-
regionalismos muy propios de un único lugar).
26-
27-
- La documentación es ENORME, cualquier traba que encuentres siempre puedes
28-
marcar el texto como “fuzzy” o para revisar en el futuro.
29-
No pierdas horas buscando la palabra perfecta.
30-
31-
- En muchos casos el mejor criterio es pensar en el vocabulario que utilizamos
32-
cuando le explicamos a otra persona, o en el trabajo. En muchas ocasiones la
33-
versión en inglés o “spanglish” de la palabra es mucho mejor que decir “git
34-
unir” (para git merge).
35-
36-
- Siempre vas a tener un review de lo que propongas y en ese intercambio otras
37-
personas van a ayudarte a destrabar las dudas que tengas.
38-
39-
- Colaborar haciendo reviews también es muy muy importante, así que si
40-
tienes un rato libre puedes comenzar por mirar los PRs pendientes de revisar.
41-
(mira la `Guía del revisor`_)
42-
43-
- Último pero no menos importante, divertite y contá con la ayuda de todes. Te
44-
esperamos en nuestro chat en telegram. ¡Gracias!
45-
14+
contribución, queremos señalar algunos
15+
:ref:`lineamientos generales <a-tener-en-cuenta>`.
4616

4717
.. note::
4818

4919
Si tienes cualquier duda, puedes enviarnos un email a docs-es@python.org.
5020

21+
Antes de comenzar
22+
-----------------
5123

52-
¡Comienza a traducir!
53-
---------------------
24+
#. Para enviar una traducción, necesitas tener un **fork** del repositorio_
25+
oficial, haciendo click en el botón encerrado en rojo.
5426

55-
#. Crea un fork del repositorio_.
27+
.. image:: fork.png
28+
:alt: botón fork
5629

5730
.. note::
5831

@@ -70,8 +43,35 @@ contribución, queremos señalar algunos lineamientos generales.
7043

7144
git remote add upstream https://github.com/python/python-docs-es.git
7245

46+
#. (Opcional) Crea un entorno virtual y actívalo::
47+
48+
python -m venv env
49+
source env/bin/activate # macOS y Linux
50+
env\Scripts\activate.bat # Windows
51+
52+
#. (Opcional) Instala los requerimientos del proyecto::
53+
54+
pip install -r requirements.txt
55+
56+
.. note::
57+
58+
Al tener instalado los requerimientos, podrás utilizas las herramientas
59+
``powrap`` y ``pospell`` para poder verificar tus archivos traducidos,
60+
y también construir la documentación localmente.
61+
62+
¡Comienza a traducir!
63+
---------------------
64+
65+
#. Selecciona un :ref:`archivo para traducir <que-archivo-traducir>`.
66+
67+
#. Verifica que estás en la rama principal del repositorio, **3.8** (esto es muy
68+
importante para evitar crear una nueva rama a partir de una traducción
69+
anterior)::
70+
71+
git checkout 3.8
72+
7373
#. Crea una rama nueva en base al artículo en el que vayas a trabajar. Por
74-
ejemplo, si vas a trabajar en el archivo ``glosario.po``, usa un nombre
74+
ejemplo, si vas a trabajar en el archivo ``library/glosario.po``, usa un nombre
7575
similar a::
7676

7777
git checkout -b traduccion-glosario
@@ -80,29 +80,31 @@ contribución, queremos señalar algunos lineamientos generales.
8080
empezar a traducir.
8181

8282
#. Cuando hayas terminado tu sesión, debes guardar tus cambios y enviarlos a
83-
GitHub de nuevo::
83+
GitHub (No olvides añadir tu nombre al archivo ``TRANSLATORS``)::
8484

85-
git commit -am 'Traducido archivo {nombre de archivo}'
85+
git add library/glosario.po
86+
git commit -m 'Traducido archivo library/glosario'
8687
git push origin traduccion-glosario
8788

88-
#. No olvides añadir tu nombre al archivo ``TRANSLATORS`` si no lo has hecho
89-
todavía. Los nombres se encuentran ordenados alfabéticamente por apellido.
90-
91-
#. Luego ve a tu página de GitHub y propone hacer un *Pull Request*.
92-
9389
.. note::
9490

91+
Mira los mensajes que el último comando imprimirá por pantalla,
92+
pues encontrarás un enlace para abrir un nuevo Pull-request directamente.
93+
9594
Puedes consultar la `ayuda oficial de GitHub para crear un Pull Request`_
9695
si lo deseas.
9796

97+
9898
#. En la descripción de la *Pull Request* escribe ``Closes #<número de issue>``
9999
(así se cierra automáticamente cuando se hace *merge*)
100100

101101
.. note::
102102

103103
Si hace tiempo que venis trabajando en una traducción es importante
104-
:ref:`mantener actualizada <mantener-actualizada>` tu copia local antes de realizar el *Pull Request*.
104+
:ref:`mantener actualizada <mantener-actualizada>` tu copia local antes
105+
de realizar el *Pull Request*.
105106

107+
.. _que-archivo-traducir:
106108

107109
¿Qué archivo traducir?
108110
----------------------
@@ -118,25 +120,51 @@ archivo es el siguiente:
118120
#. ¡Empieza a traducir!
119121

120122

123+
.. _a-tener-en-cuenta:
121124

122125
A tener en cuenta
123126
-----------------
124127

125-
* No debes traducir el contenido de ``:ref:...`` y ``:term:...``.
128+
* Esta traducción es mantenida por **personas de todo el mundo** que hablan el
129+
idioma Español. No queremos atarla a ninguna región en particular y creemos
130+
que es un valor extra la diversidad de la misma. Vas a encontrar secciones
131+
con diferentes tonalidades de países, regiones o estilos. Lo único que pedimos
132+
es **consistencia** dentro de un mismo módulo o sección (es decir no cambiar de
133+
estilo de un párrafo a otro, por ejemplo) y siempre intentar que la persona del
134+
otro lado pueda entender lo que estamos escribiendo (no usar lunfardo o
135+
regionalismos muy propios de un único lugar).
136+
137+
* En muchos casos el **mejor criterio** es pensar en el vocabulario que utilizamos
138+
cuando le explicamos a otra persona, o en el trabajo. En muchas ocasiones la
139+
versión en inglés o “spanglish” de la palabra es mucho mejor que decir “git
140+
unir” (para git merge).
141+
142+
* Siempre vas a tener una **revisión de lo que propongas** y en ese intercambio otras
143+
personas van a ayudarte a destrabar las dudas que tengas.
144+
145+
* Colaborar **haciendo revisiones** también es muy muy importante, así que si
146+
tienes un rato libre puedes comenzar por mirar los PRs pendientes de revisar.
147+
(mira la :doc:`Guía del revisor <reviewers-guide>`)
148+
149+
* La documentación es ENORME, cualquier traba que encuentres siempre puedes
150+
marcar el texto como **"fuzzy"** o para revisar en el futuro.
151+
No pierdas horas buscando la palabra perfecta.
152+
153+
* **No debes** traducir el contenido de ``:ref:...``, ``:term:...``, ``:dfn:...``, etc.
126154

127155
* Si tienes que usar palabras en inglés debes ponerlas en *cursiva* (rodeadas
128156
por asteriscos)
129157

130-
* Puedes revisar las :doc:`faq` para leer sobre problemas conocidos.
158+
* Puedes revisar las :doc:`Preguntas Frecuentes <faq>` para leer sobre problemas conocidos.
131159

132-
* Si traduces un título que es un link, por favor traduce el link también (por
160+
* Si **traduces un título que es un enlace**, por favor traduce el link también (por
133161
ejemplo un artículo a Wikipedia). En caso de que no haya una traducción del
134162
artículo en Wikipedia deja el título sin traducir.
135163

136-
* Tenemos una `Memoria de Traducción`_, que usamos para tener consistencia con
137-
algunos términos.
164+
* Tenemos una :doc:`Memoria de Traducción <translation-memory>`, que usamos para tener
165+
consistencia con algunos términos.
138166

139-
* Si tienes una duda sobre una palabra o término, escríbelo como mejor suene
167+
* Si tienes una **duda sobre una palabra o término**, escríbelo como mejor suene
140168
para vos y marca ese párrafo como "Need work" / "Necesita trabajo" en
141169
*poedit*. Además, escribe un comentario explicando cuál es el termino en ese
142170
párrafo con el que no estabas segura.
@@ -148,11 +176,14 @@ A tener en cuenta
148176
tiene una traducción al Español en la barra de la izquierda. Suelen estar
149177
bastante bien explicados.
150178

151-
* Te recomendamos abrir una Pull Request aunque sea en formato borrador (marcada
179+
* Te recomendamos abrir una **Pull Request aunque sea en formato borrador** (marcada
152180
como draft) desde los primeros commits de la traducción de tu fichero. De esta
153181
forma, puedes recibir feedback desde el principio que puedes aplicar al resto
154182
de la traducción, y probar el build más a menudo.
155183

184+
* Último pero no menos importante, **divertite y contá con la ayuda de todes**. Te
185+
esperamos en nuestro chat en telegram. ¡Gracias!
186+
156187

157188
.. note::
158189

@@ -181,10 +212,6 @@ Tendrás que navegar hasta el archivo que hayas cambiado para ver cómo se visua
181212
.. _poedit: https://poedit.net/
182213

183214
.. _nuestro canal de Telegram: https://t.me/python_docs_es
184-
.. _Memoria de traducción:
185-
https://python-docs-es.readthedocs.io/page/translation-memory.html
186-
.. _Guía del revisor:
187-
https://python-docs-es.readthedocs.io/page/reviewers-guide.html
188215
.. _la traducción al Portugués: https://docs.python.org/pt-br/3/
189216
.. _lista de issues en GitHub:
190217
https://github.com/python/python-docs-es/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+no%3Aassignee+translate

.overrides/faq.rst

+32-6
Original file line numberDiff line numberDiff line change
@@ -193,12 +193,12 @@ Y luego accediendo a http://localhost:8000/
193193
.. _mantener-actualizada:
194194

195195
¿Cómo actualizar mi copia local del repositorio?
196-
---------------------------------------------------------
196+
------------------------------------------------
197197

198-
Es recomendable mantener actualizada nuestra copia local para evitar
199-
posibles conflictos entre los archivos que trabajamos y la última versión disponible
200-
en el repositorio remoto.
201-
Primero, necesitamos bajar los cambios de *upstream* (es el nombre que asignamos al
198+
Es recomendable mantener actualizada nuestra copia local para evitar
199+
posibles conflictos entre los archivos que trabajamos y la última versión disponible
200+
en el repositorio remoto.
201+
Primero, necesitamos bajar los cambios de *upstream* (es el nombre que asignamos al
202202
repositorio principal de la traducción). Se hace de la siguiente manera::
203203

204204
git fetch upstream
@@ -207,11 +207,37 @@ Luego nos vamos a nuestra rama local, confirmamos e impactamos esos cambios::
207207

208208
git checkout 3.8
209209
git merge upstream/3.8
210-
git push origin 3.8
210+
git push origin 3.8
211211

212212
¡Eso es todo!
213213

214214

215+
¿Son importantes los dobles espacios en el original?
216+
----------------------------------------------------
217+
218+
No.
219+
220+
En realidad, no tienen ningún efecto. Sphinx se da cuenta automáticamente de esto y simplemente
221+
deja un solo espacio en la versión final. Así que, no te preocupes si ves dos espacios juntos.
222+
223+
Si estás interesada en saber más sobré "¿Por qué se usan dobles espacios?" puedes leer este artículo:
224+
`How Many Spaces Should Be After a Period? <https://www.instructionalsolutions.com/blog/one-space-vs-two-after-period>`_
225+
226+
227+
¿Puedo agregar "estilo de código" a los nombres de las funciones/métodos/clases/etc?
228+
------------------------------------------------------------------------------------
229+
230+
No.
231+
232+
Si aparece el nombre de una función (por ejemplo, "IncrementalParser") en el original y no tiene ningún estilo asociado
233+
(no está en cursiva, ni en negrita ni en estilo de código), aunque sientas la tentación de ponerla como
234+
``IncrementalParser``, no debes hacerlo.
235+
236+
En principio, no debemos cambiar el formato de estas palabras. Si está con asteriscos, lo dejamos con asteriscos.
237+
Si está con backticks, lo dejamos con los backticks, etc. Si realmente crees que es un error y debería
238+
estar con un formato distinto, debes reportarlo en el repositorio de CPython.
239+
240+
215241
¿Tienen una lista de correo?
216242
----------------------------
217243

.overrides/fork.png

33.6 KB
Loading

.overrides/pospell_fallo_spelling.png

35.5 KB
Loading
Loading

.overrides/powrap_fail.png

32.9 KB
Loading

.overrides/reviewers-guide.rst

+38-5
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33
================================
44
Guía para revisar una traducción
55
================================
6+
7+
Antes que nada, queremos compartir contigo `unos videos`_ que uno de nuestros colaboradores ha preparado donde se explica el resumen del proceso a través de un ejemplo.
8+
9+
Asimismo, si nunca has hecho una revisión pero ya has colaborado con el proyecto, te recomendamos que pruebes esta otra manera de colaborar, ya que permite ponerse en el lugar de otra persona, y muchas veces ayuda a mejorar las traducciones propias.
10+
11+
.. _`unos videos`: https://www.youtube.com/watch?v=uIaQMTuwtoU&list=PLma583Z70SlztPF8SitlWJZx3SW1aAePk&index=3&t=7s&ab_channel=Cristi%C3%A1nMaureira-Fredes
12+
613
El costado humano
714
=================
815
Teniendo en cuenta que todes somos voluntaries en este proyecto, es importante que la forma de comunicarnos sea clara, concisa y amable. Como revisor/a, ayudarás a voluntaries de diferentes culturas y lugares del mundo para que su traducción sea lo más acertada posible y podamos acercar Python a las comunidades de habla hispana. Recuerda que del otro lado de un PR hay una persona que ha dedicado tiempo y esfuerzo; es por eso es la forma en que le des una devolución sobre su trabajo influirá en su actitud hacia el proyecto…¡y en sus ganas de seguir participando de nuestra comunidad!
@@ -32,8 +39,34 @@ El costado técnico
3239
==================
3340
Al revisar una traducción, deberás tener en cuenta ciertos aspectos propios de una traducción técnica de esta índole. Además de que debe entenderse el texto en español y que debes respetar el contenido de la documentación original (ver "A tener en cuenta" en la `Guía para contribuir en la traducción <https://python-docs-es.readthedocs.io/es/3.8/CONTRIBUTING.html>`_), contamos con herramientas en este proyecto que pueden fallar en ciertos casos, y que como revisor/a deberás tener en cuenta.
3441

35-
Cuatro razones por las que puede fallar el *build* de Travis:
36-
* `powrap` falla
37-
* `pospell` falla
38-
* Dict está duplicado
39-
* Sphinx falla
42+
Tres razones por las que puede fallar el *build* de Travis:
43+
44+
``powrap`` falla
45+
---------------------
46+
47+
.. image:: powrap_fail.png
48+
49+
Para facilitar la comparación de ficheros se emplea este programa que va a hacer que todas las líneas tengan el mismo tamaño. Solucionar este problema en nuestra traducción es muy sencillo, solo hay que instalar la herramienta powrap en nuestro entorno y ejecutar el comando ``powrap nuestro_fichero.po``
50+
51+
52+
``pospell`` falla
53+
---------------------
54+
55+
Los fallos en pospell pueden ser variados y según con que nos encontremos tenemos que actuar de una manera u otra. En principio es un chequeo de ortografía contra un diccionario de español, por lo que nos va a fallar tanto si usamos palabras en otro idioma, como si usamos palabras en español mal escritas como si usamos palabras que simplemente no están en el diccionario. Por ejemplo:
56+
57+
.. image:: pospell_fallo_spelling.png
58+
59+
En este primer caso simplemente hay un error en la ortografía por lo que solucionarlo en nuestra traducción será lo únicoque tengamos que hacer.
60+
61+
.. image:: pospell_warning_and_english_words.png
62+
63+
En este segundo, en cambio, vemos un par de cosas más interesantes. En primer lugar, tenemos un warning de rst, donde nos da un error porque unas comillas no han sido reconocidas como final de una palabra. Si te fijas en el texto esto ocurre donde están los paréntesis pegados a la expresión entre comillas dobles SNDCTL_DSP_SYNC. Añadir un espacio allí solucionará nuestro problema. Por otro lado, nos lanza una serie de palabras que han fallado en pospell, pero como vemos, son o bien términos técnicos, o nombres en inglés (en este caso posiblemente parte de un nombre propio) y una palabra que está correctamente escrita en español pero es un poco técnica. Por tanto, en este caso no queremos cambiarlas en nuestra traducción, sino que queremos que sean una excepción en el chequeo de pospell. Para ello, lo que debemos hacer es o bien crear o bien incluir (si ya está creado) en un diccionario llamado como nuestro fichero y que se emplace en la carpeta dictionaries las palabras que deben ser una excepción. Por ejemplo, los diccionarios para el fichero clinic o argparse los encontramos dentro de ./dictionaries como howto_clinic.txt y library_argparse.txt. Cuando se haga el build se tendrán en cuenta estas excepciones y no tendremos ese error de pospell.
64+
65+
Sphinx falla:
66+
---------------------
67+
68+
Durante la renderización de la documentación hay toda una serie de referencias cruzadas, que deben permanecer igual en español que en inglés. Un fallo habitual es el siguiente:
69+
70+
.. image:: sphinx_warnings_example_inconsistent_terms.png
71+
72+
Indica que alguna de las referencias falta en la traducción. Lo más probable es que al traducir se haya cambiado algo de la sintaxis particular como las comillas, y por eso no esté siendo reconocida.
Loading

0 commit comments

Comments
 (0)