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

Wrap output of exercism debug in markdown Codeblock ready to paste #869

Open
NobbZ opened this issue Aug 8, 2019 · 1 comment
Open

Wrap output of exercism debug in markdown Codeblock ready to paste #869

NobbZ opened this issue Aug 8, 2019 · 1 comment

Comments

@NobbZ
Copy link
Member

NobbZ commented Aug 8, 2019

We often ask to copy and paste the output of exercism debug into the gitter, some GitHub issue or the slack.

This requires students to actually know about fenced code blocks or other means of wrapping stuff before posting. Not properly wrapped output often gets reinterpreted and formatted by the rendered of the service we paste into. This often makes the output hard to read.

Therefore I suggest wrapping the output in a fenced code block making it look like this:

```
... Exercism debug output ...
```

This will be colorful when posting to GitHub as it will try to guess a language on its own and probably will not pick "plain", but gitter and slack both don't support specifying the language on the opening fence, therefore I consider this the greatest common denominator to choose from.

Downside of this is, when a student misses to copy either opening or closing fence or even a single backtick, it might blow up the complete post of that user when writing something large in GitHub.

@kytrinyx
Copy link
Member

kytrinyx commented Aug 8, 2019

I think it's worth a try, @NobbZ !

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

2 participants