Skip to content
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.

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

Guía de estilo #6

Open
eliocamp opened this issue Sep 18, 2021 · 5 comments
Open

Guía de estilo #6

eliocamp opened this issue Sep 18, 2021 · 5 comments

Comments

@eliocamp
Copy link
Collaborator

Tendríamos que ponernos de acuerdo con el estilo que vamos a usar.

Una cosa que ya veo es que algunas partes están escritas en segunda persona singular ("... hace tus análisis más ordenados y reproducibles...", "Hacé click en el menú...") y otras en segunda persona plural ("...posiblemente tengan un script...") y otras en primera persona plural ("... podemos graficar histogramas con geom_histogram()...").

¿Qué estilo nos gusta más? Las otras guías tienen un tono bien impersonal; nunca le hablan al lector.

@paocorrales
Copy link
Collaborator

Y otra cosa, tendríamos que definir cuando usar monospace, como mencionar paquetes, etc.

Primera propuesta:

  • Los nombres de paquete se escriben normalmente, a menos que se quiera hacer énfasis. Por ejemplo la primera vez que se menciona ggplot2 en el capítulo de gráficos puede ir con negrita.
  • Usamos monospace para funciones, sus argumentos, nombres de variables y operadores
  • Cuando nos referimos a las funciones usamos los (), por ejemplo ggplot()

@yabellini
Copy link
Collaborator

Tengo la tendencia de usar segunda persona del plural, pero si el resto de las guías no se dirigen a nadie, entonces podemos ver de arreglarlo. ¿Cual prefieren ustedes?

@eliocamp
Copy link
Collaborator Author

A mí me da la sensación de que segunda persona plural sólo tiene sentido en el contexto de un curso donde son muchas personas.

Googleé un poco y en este manual reocmiendan

Redacta las instrucciónes cónjugandó lós verbós en la segunda persóna gramatical, es decir, cómó si te dirigieras al ótró cón el que hablas

Pero luego...

La segunda persóna gramatical puede estar en singular, cuandó cónjugas utilizandó “tu ” ó “usted”; ó en plural, cuandó te diriges a varias persónas: “ustedes” ó “vósótrós”.

Así que no es de ayuda 🤣

A mí me gusta más el singular. No sé que piensa @paocorrales

@paocorrales
Copy link
Collaborator

No si si tengo una preferencia, la mezcla actual en parte es culpar de que cambia del singular al plural sin pensarlo.

@yabellini
Copy link
Collaborator

Metamosle con el singular.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants