Usando etiquetas apropiadas para los mensajes con codigo/logs/errores!

[MinusFour]

TL;DR: Usa las etiquetas correspondientes

Últimamente he visto bastantes mensajes sin formato alguno. Usuarios nuevos generalmente. Así que he decidido explicar el problema y la solución.

Primero, el problema. No hay una clara distinción entre texto y código/errores/logs/etc. Al estar leyendo, lo siguiente puede ser parte de un programa, luego regresar a una conversación, luego volver a escribir parte de un programa, etc. Al final obtenemos un mensaje el cual es muy difícil de leer. Observemos un caso:

Usuario solicita ayuda con un shell script pero simplemente pega el código encima del mensaje. La transición no es tan difícil en este caso, sin embargo los miembros pertenecientes al código no son muy claros.

La lectura es algo pesada sobre todo con strings y es un tanto difícil de corregir. Ahora, si usamos etiquetas GESHI:

Obtenemos un mensaje mas fácil de leer. Algunos errores se pueden observar mejor de esta forma:

Es importante observar que lo único que cambio en el mensaje es que ha agregado etiquetas code delimitadas por [] al principio y al final del texto seleccionado. Noten que en la primera etiqueta se usa tambien '=bash'. Esto significa que el codigo sigue las reglas sintacticas del lenguaje bash.

Esta no es la única forma, también es posible de hacerlo asi:

Es importante posicionar el texto del código/log/etc en medio de las dos etiquetas para que reciban el formato adecuado.

Algunos se habran dado cuenta que el script tecnicamente no especifica la shell de Bash (Bourne Again Shell) sino de sh de las cuales hay muchas posibilidades.. (Bourne Shells, DASH, etc). Realmente puede acabar siendo utilizado en shells diferentes pero por lo general siguen las mismas reglas sintácticas por lo que es posible usarlo para los dos tipos. Es importante tratar de usar el modo correspondiente al lenguaje a utilizar sin embargo no siempre es posible, no se encuentran disponibles todos los lenguajes de modo que queda a su discreción utilizar un modo similar o no.

En caso de no encontrar un lenguaje o si quieren evitar posibles confusiones con uno que es similar, pueden usar simplemente las etiquetas code sin ningún parámetro.

Tal es el caso con la gran mayoría de los logs y mensajes de errores que quieran publicar. El resultado es un poco mas legible y se encuentra espaciado uniformemente (la longitud de los caracteres es la misma).

Al usar las etiquetas correspondientes, la lectura y comprensión de sus mensajes es más fácil. Sus aportaciones son mas entendibles y la probabilidad de que alguien aporte a su tema aumenta.