Skip to content

Clarify why two or one spaces and code formatting #1010

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 8, 2020
Merged

Clarify why two or one spaces and code formatting #1010

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
22ebe3b
Clarify why two or one spaces and code formatting
humitos Oct 8, 2020
5ff2ded
Backticks and *
humitos Oct 8, 2020
646c51f
Update .overrides/faq.rst
humitos Oct 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 32 additions & 6 deletions .overrides/faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,12 +193,12 @@ Y luego accediendo a http://localhost:8000/
.. _mantener-actualizada:

¿Cómo actualizar mi copia local del repositorio?
---------------------------------------------------------
------------------------------------------------

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
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
Expand All @@ -207,11 +207,37 @@ Luego nos vamos a nuestra rama local, confirmamos e impactamos esos cambios::

git checkout 3.8
git merge upstream/3.8
git push origin 3.8
git push origin 3.8
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sé que este cambio no es de acá...
pero ahora que lo leo...

Creo que con esto recomendamos actualizar las ramas locales, pero no la copia local del repositorio, quizás podríamos explicar como actualizar el fork y como actualizar la rama por separado?
Quizás entendí mal, pero para mi rama local sería "traduccion-xxxxxxxx" y no 3.8 del fork.

Con este mecanismo cuando alguien actualice la rama local, el repo seguirá desactualizado.
Que opinas? (lo podemos hacer en otro PR)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yo entiendo que lo que queremos es que tengan su branch 3.8 local y remota actualizada. ¿Porqué? Porque luego, cuando hagan una nueva rama para trabajar en un archivo nuevo, queremos que tengan los últimos cambios en 3.8 antes de empezar la nueva rama.

Creo que si la persona está trabajando en traduccion-xxx localmente, en principio, no sería necesario actualizar su rama con la upstream/3.8 ya que no hay otra persona tocado el archivo en el que se está trabajando en esa rama.

Supongo que habrá casos en los que sea necesario. Onda, "Esa palabra ya fue agregada al diccionario en esta otra PR que está mergeada. Tenés que traerte los cambios de upstream/3.8 en tu branch local" --pero no creo que sea muy frecuente. No lo sé. De cualquier manera, me parece bien de agregar otra pregunta explicando eso si es necesario.


¡Eso es todo!


¿Son importantes los dobles espacios en el original?
----------------------------------------------------

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? <https://www.instructionalsolutions.com/blog/one-space-vs-two-after-period>`_


¿Puedo agregar "estilo de código" a los nombres de las funciones/métodos/clases/etc?
------------------------------------------------------------------------------------

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.


¿Tienen una lista de correo?
----------------------------

Expand Down