Skip to content

Commit 1c2c9bd

Browse files
committed
Merge branch '3.8' into pr-749
2 parents 00c544d + a23a815 commit 1c2c9bd

File tree

551 files changed

+31205
-6300
lines changed

Some content is hidden

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

551 files changed

+31205
-6300
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ coverage.xml
6565
.idea/
6666
/translation-memory.po
6767
/locale/
68+
*.swp
69+
*~
6870

6971
# OSX
7072
.DS_Store

.overrides/CONTRIBUTING.rst

Lines changed: 81 additions & 52 deletions
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,33 @@ 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 contruir 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**::
68+
69+
git checkout 3.8
70+
7371
#. 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
72+
ejemplo, si vas a trabajar en el archivo ``library/glosario.po``, usa un nombre
7573
similar a::
7674

7775
git checkout -b traduccion-glosario
@@ -80,29 +78,31 @@ contribución, queremos señalar algunos lineamientos generales.
8078
empezar a traducir.
8179

8280
#. Cuando hayas terminado tu sesión, debes guardar tus cambios y enviarlos a
83-
GitHub de nuevo::
84-
85-
git commit -am 'Traducido archivo {nombre de archivo}' git push origin
86-
traduccion-glosario
87-
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.
81+
GitHub (No olvides añadir tu nombre al archivo ``TRANSLATORS``)::
9082

91-
#. Luego ve a tu página de GitHub y propone hacer un *Pull Request*.
83+
git add library/glosario.po
84+
git commit -m 'Traducido archivo library/glosario'
85+
git push origin traduccion-glosario
9286

9387
.. note::
9488

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

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

10199
.. note::
102100

103101
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*.
102+
:ref:`mantener actualizada <mantener-actualizada>` tu copia local antes
103+
de realizar el *Pull Request*.
105104

105+
.. _que-archivo-traducir:
106106

107107
¿Qué archivo traducir?
108108
----------------------
@@ -118,25 +118,51 @@ archivo es el siguiente:
118118
#. ¡Empieza a traducir!
119119

120120

121+
.. _a-tener-en-cuenta:
121122

122123
A tener en cuenta
123124
-----------------
124125

125-
* No debes traducir el contenido de ``:ref:...`` y ``:term:...``.
126+
* Esta traducción es mantenida por **personas de todo el mundo** que hablan el
127+
idioma Español. No queremos atarla a ninguna región en particular y creemos
128+
que es un valor extra la diversidad de la misma. Vas a encontrar secciones
129+
con diferentes tonalidades de países, regiones o estilos. Lo único que pedimos
130+
es **consistencia** dentro de un mismo módulo o sección (es decir no cambiar de
131+
estilo de un párrafo a otro, por ejemplo) y siempre intentar que la persona del
132+
otro lado pueda entender lo que estamos escribiendo (no usar lunfardo o
133+
regionalismos muy propios de un único lugar).
134+
135+
* En muchos casos el **mejor criterio** es pensar en el vocabulario que utilizamos
136+
cuando le explicamos a otra persona, o en el trabajo. En muchas ocasiones la
137+
versión en inglés o “spanglish” de la palabra es mucho mejor que decir “git
138+
unir” (para git merge).
139+
140+
* Siempre vas a tener una **revisión de lo que propongas** y en ese intercambio otras
141+
personas van a ayudarte a destrabar las dudas que tengas.
126142

127-
* Si tienes que usar palabras en inglés debes ponerlas en *italics* (rodeadas
143+
* Colaborar **haciendo revisiones** también es muy muy importante, así que si
144+
tienes un rato libre puedes comenzar por mirar los PRs pendientes de revisar.
145+
(mira la `Guía del revisor`_)
146+
147+
* La documentación es ENORME, cualquier traba que encuentres siempre puedes
148+
marcar el texto como **"fuzzy"** o para revisar en el futuro.
149+
No pierdas horas buscando la palabra perfecta.
150+
151+
* **No debes** traducir el contenido de ``:ref:...``, ``:term:...``, ``:dfn:...``, etc.
152+
153+
* Si tienes que usar palabras en inglés debes ponerlas en *cursiva* (rodeadas
128154
por asteriscos)
129155

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

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

136162
* Tenemos una `Memoria de Traducción`_, que usamos para tener consistencia con
137163
algunos términos.
138164

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

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

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

157186
.. note::
158187

.overrides/faq.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ pospell. Pospell puede ser instalada en tu entorno de Python empleando pip
2626
Una vez instalado, para chequear el fichero .po sobre el que estás trabajando,
2727
ejecuta desde el directorio principal del repo::
2828

29-
pospell -p dict -l es_AR -l es_ES path/tu_fichero.po
29+
awk 1 dict dictionaries/*.txt > dict.txt
30+
pospell -p dict.txt -l es_AR -l es_ES path/tu_fichero.po
3031

3132
pospell emplea la herramienta de diccionarios hunspell. Si pospell falla dando
3233
como error que no tiene hunspell instalado, lo puedes instalar así:

.overrides/fork.png

33.6 KB
Loading

.overrides/git_diff.rst

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
:orphan:
2+
3+
=========================
4+
Simplificar el `git diff`
5+
=========================
6+
7+
El comando `git diff` tiene datos que pueden llegar a ser inútiles como por ejemplo:
8+
9+
.. code-block:: diff
10+
11+
-#: ../Doc/library/signal.rst:406
12+
+#: ../Doc/library/signal.rst:408
13+
14+
La instalación de `podiff` mediante `pip` no se encuentra totalmente funcional, pero los usuarios de macOS
15+
podrán continuar con estas instrucciones.
16+
17+
Primero debemos instalar brew. Si no lo tienes instalado puedes seguir el instructivo de instalación Brew_.
18+
19+
.. tabs::
20+
21+
.. tab:: Mac
22+
23+
Para instalar brew en Mac ejecutar el siguiente comando::
24+
25+
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
26+
27+
Una vez instalado brew, hay que instalar podiff, para ellos ejectar el siguiente comando:
28+
29+
.. code-block:: bash
30+
31+
brew install podiff
32+
33+
Luego abrir el archivo de configuración del respositorio local y escribir al final:
34+
35+
.. code-block:: bash
36+
37+
[diff "podiff"]
38+
command = $(brew --prefix)/bin/podiff -D--minimal
39+
40+
Luego, si no existiese el archivo `.gitatributes` en la carpeta dónde se encuentran los
41+
archivos .po con los que se van a trabajar, crealo, y luego, agregar la siguiente línea
42+
43+
.. code-block:: bash
44+
45+
*.po diff=podiff
46+
47+
Para las distribuciones de Linux se pueden utilizar algunas herramientas, como por ejemplo podiff_ y
48+
potools_, que son compatibles con Python 2. Se puede utilizar `pip` para instalarlas.
49+
50+
.. code-block:: bash
51+
52+
pip install podiff
53+
# o
54+
pip install potools
55+
56+
.. _Brew: https://docs.brew.sh/Installation
57+
.. _podiff: https://pypi.org/project/podiff/
58+
.. _potools: https://pypi.org/project/potools/

.overrides/reviewers-guide.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
:orphan:
2+
13
================================
24
Guía para revisar una traducción
35
================================
@@ -14,14 +16,17 @@ La devolución deberá ser acertada para transmitir el mensaje que necesitamos q
1416
No olvides que esto se trata de una traducción técnica y como tal, el objetivo es que, básicamente, la persona que la lea pueda entender cómo usar Python. Es por esto que, si bien es importante que la sintaxis sea correcta, el objetivo no es hacer una revisión intensiva del uso del español, a menos que la forma en que se expresó la idea imposibilite que otre la entienda.
1517

1618
Para esto, Github te ofrece opciones para afrontar una PR (ver botón *Review Changes* arriba a la derecha de los archivos modificados por les traductores):
19+
1720
* *Comment*: Puedes dejar un comentario sin necesariamente aprobar la PR. Asegúrate de hacerlo con claridad para que quien tradujo sepa que debe modificar algunas cosas antes de que su PR sea aprobada.
1821
* *Approve*: Dejar esta opción solo para PRs que no necesitan modificación alguna o que solo tengan pocas faltas de ortografía o errores de tipeo, o algún error que no genere un conflicto mayor en la traducción y en su integración al repositorio.
1922
* *Request Changes*: Utiliza esta opción cuando la traducción necesita varias modificaciones que afectan su integración al repositorio. En este caso también asegúrate de que tu mensaje sea claro y amable para acompañar al traductor en el proceso de modificar y lograr que la PR se apruebe.
2023

2124
*Tips*
2225
======
23-
* PRs de más de 1000 líneas: Te sugerimos hacer un comentario al principio del PR para indicar hasta qué línea haz hecho el review y qué hay que revisar hasta ese hito.
24-
* “Needs work” genera en la línea anterior “#fuzzy” para que el traductor revise esa línea. Se puede usar cuando la traducción necesita revisión y en ese momento no puedes sugerir una traducción alternativa.
26+
27+
* PRs de más de 1000 líneas: Te sugerimos hacer un comentario al principio del PR para indicar hasta qué línea haz hecho el review y qué hay que revisar hasta ese hito. También si tú mismo vas a continuar la review, pero no puedes hacerla de una sola vez, es útil para saber donde retomar tu trabajo.
28+
* El uso de la opción "Needs work" en poedit genera en la línea anterior al párrafo un comentario "#, fuzzy" para que el traductor revise esa línea. Se puede usar cuando la traducción necesita revisión y en ese momento no puedes sugerir una traducción alternativa. Ten en cuenta que los párrafos con esa marca no aparecerán traducidos en el build. Como revisor, también podrías incluir ese comentario tu mismo como sugerencia.
29+
* Al igual que cuando uno traduce, en el proceso de revisión puedes consultar y emplear las herramientas que tenemos. Por ejemplo, si no estás seguro sobre la traducción de un término sobre el que puede que ya hayamos tomado una decisión consensuada, puedes consultar la memoria de traducción [,](https://github.com/python/python-docs-es/blob/3.8/.overrides/translation-memory.rst) usar `scripts/find_in_po.py` o incluso comentarlo en nuestro grupo de Telegram.
2530

2631
El costado técnico
2732
==================

.overrides/tools/templates/customsourcelink.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ <h3>{{ _('This Page') }}</h3>
44
<ul class="this-page-menu">
55
<li><a href="{{ pathto('bugs') }}">{% trans %}Report a Bug{% endtrans %}</a></li>
66
<li>
7-
<a href="https://github.com/PyCampES/python-docs-es/blob/{{ version }}/{{ sourcename|replace('.rst.txt', '.po') }}"
7+
<a href="https://github.com/python/python-docs-es/blob/{{ version }}/{{ sourcename|replace('.rst.txt', '.po') }}"
88
rel="nofollow">{{ _('Show Source') }}
99
</a>
1010
</li>

.overrides/tools/templates/indexsidebar.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ <h3>Recursos</h3>
88
<ul>
99
<li><a href="https://mail.python.org/mailman3/lists/docs-es.python.org/">Lista de correos</a></li>
1010
<li><a href="https://t.me/python_docs_es">Canal de Télegram</a></li>
11-
<li><a href="https://github.com/PyCampES/python-docs-es">Repositorio GitHub</a></li>
11+
<li><a href="https://github.com/python/python-docs-es">Repositorio GitHub</a></li>
1212
</ul>

0 commit comments

Comments
 (0)