Guía de estilo
Opened this issue · 5 comments
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.
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()
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?
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
No si si tengo una preferencia, la mezcla actual en parte es culpar de que cambia del singular al plural sin pensarlo.
Metamosle con el singular.