| orphan: |
|---|
Pregunta, |:smile:|. Tenemos un grupo de Telegram en el que hay mucha gente que te puede ayudar.
Uno de los chequeos que realiza nuestro servidor de github cada vez que hacemos un pull de request es un test de corrección ortográfico usando la herramienta pospell. Pospell puede ser instalada en tu entorno de Python empleando pip (https://pypi.org/project/pospell/):
pip install pospell
Una vez instalado, para chequear el fichero .po sobre el que estás trabajando, ejecuta desde el directorio principal del repo:
python scripts/check_spell.py path/tu_fichero.po
pospell emplea la herramienta de diccionarios hunspell. Si pospell falla dando como error que no tiene hunspell instalado, lo puedes instalar así:
.. tabs::
.. tab:: Mac
Utilizando ``brew`` (https://formulae.brew.sh/formula/hunspell)::
brew install hunspell
Este comando instala hunspell, pero puede que todavía necesites los diccionarios.
Los diccionarios de Hunspell (``*.aff`` y ``*.dic``) en Mac deben estar en la
carpeta ``~/Library/Spelling/`` o ``/Library/Spelling/``. Puedes encontrar
diccionarios de español en las webs de Open Office, Mozilla y otros proyectos
open source (ejemplo: https://cgit.freedesktop.org/libreoffice/dictionaries/tree/).
.. tab:: Linux
Utilizando el gestor de paquetes de tu distribución::
# Arch Linux
yay -S hunspell-es_any
# Ubuntu Linux
apt install hunspell-es
Estamos trabajando para unificar el uso de un mismo set de diccionarios de español, pero por el momento el chequeo que hacemos es con los diccionarios es_AR y es_ES.
Si pospell falla diciendo que no conoce una palabra, pero estamos seguros que esa palabra está bien escrita,
debemos agregarla al diccionario que pospell usa internamente para comprobar las palabras.
Para eso debes editar (o crear, si no existe) el archivo <archivopo>.txt dentro del direcorio dictionaries
y agregar esa palabra al final de este archivo.
Nota que debes reemplazar <archivopo> por el nombre del archivo que estés traduciendo.
Por ejemplo, si estás traduciendo library/decimal.po, debes editar/crear el archivos dictionaries/library_decimal.txt.
En la ayuda de git puedes encontrar información sobre este problema frecuente: https://help.github.com/es/github/using-git/configuring-git-to-handle-line-endings
Cuando uses poedit en Mac, es muy probable que te cambie las comillas comunes que debemos utilizar
por comillas Smart Quotes automáticamente. Debes desactivar este comportamiento para usar el que necesitamos.
Puedes hacerlo haciendo
- click derecho con el mouse en el texto que estás editando
- Substitutions
- Smart Quotes
y repetir el proceso para Smart Dashes.
Tip
Este comando te puede ayudar a cambiar todas las comillas:
sed -i **/*.po -e 's|[“”]|\\"|g'
Cuando veas el :ref: usado así,
In the :ref:`article` you can find more examples.No debes traducir article, ya que es una referencia a otro lugar de la documentación. En la traducción al Español se mostrará el título de ese artículo en Español --no te preocupes.
Si en cambio lo ves usado así,
In the section :ref:`how to redirect to a file <how-to-redirect-to-file>` from the logging HOWTO guide.Sí debes traducir la parte que dice how to redirect to a file,
pero no debes traducir how-to-redirect-to-file.
Note
Pueder leer más sobre el rol :ref: de Sphinx en su documentación oficial para entender mejor como funcionan las referencias,
aunque no es necesario que lo sepas para la traducción.
Warning
Requiere un poco de conocimiento de Python (para crear un entorno virtual) e instalar un paquete del sistema operativo.
Para utilizar pre-commit y así ejecutar unos pequeños tests antes de hacer un commit y enviar tus cambios a tu Pull Request,
debes seguir estos pasos:
Instalar
pre-commit:pip install pre-commit
Configurar
pre-commiten el repositorio depython-docs-es:cd python-docs-es/ pre-commit install
Instalar
hunspell:# Arch Linux yay -S hunspell-es_any # Ubuntu Linux apt install hunspell-es
Luego, cada vez que realices un commit se ejecutará pre-commit y validará tus archivos.
Note
Si por cualquier motivo no está funcionando pre-commit y no te deja hacer push de tus cambios,
lo puedes desinstalar simplemente mediante: pre-commit uninstall.
Note
Necesitas un poco de conocimiento para instalar make en tu sistema operativo.
Desde el mismo directorio python-docs-es/ que se creó cuando hiciste git clone puedes ejecutar:
make build
Este comando demorará unos minutos y generará toda la documentación en formato HTML en tu computadora. Puedes ver el resultado con tu navegador de internet (Firefox, Chrome, etc) ejecutando:
make serve
Y luego accediendo a http://localhost:8000/
Es recomendable mantener actualizada nuestra copia local para evitar posibles conflictos entre los archivos que trabajamos y la última versión disponible en el repositorio remoto. Primero, necesitamos bajar los cambios de upstream (es el nombre que asignamos al repositorio principal de la traducción). Se hace de la siguiente manera:
git fetch upstream
Luego nos vamos a nuestra rama local, confirmamos e impactamos esos cambios:
git checkout |pythonversion| git merge upstream/|pythonversion| git push origin |pythonversion|
¡Eso es todo!
No.
En realidad, no tienen ningún efecto. Sphinx se da cuenta automáticamente de esto y simplemente deja un solo espacio en la versión final. Así que, no te preocupes si ves dos espacios juntos.
Si estás interesada en saber más sobré "¿Por qué se usan dobles espacios?" puedes leer este artículo: How Many Spaces Should Be After a Period?
No.
Si aparece el nombre de una función (por ejemplo, "IncrementalParser") en el original y no tiene ningún estilo asociado
(no está en cursiva, ni en negrita ni en estilo de código), aunque sientas la tentación de ponerla como
IncrementalParser, no debes hacerlo.
En principio, no debemos cambiar el formato de estas palabras. Si está con asteriscos, lo dejamos con asteriscos. Si está con backticks, lo dejamos con los backticks, etc. Si realmente crees que es un error y debería estar con un formato distinto, debes reportarlo en el repositorio de CPython.
Sí.
No tiene mucho tráfico aún ya que estamos usando más el canal de Telegram por el momento. Puedes suscribirte ingresando aquí.
