Fix tests by adding markdown tags

[apiraino]

I noticed that we have a command mdbook test, I have run it and discovered a massive quantity of linting errors.

I did a random visual check and adding the console parameter to all these quoted texts does not seems to change anything but fixes the tests.

So maybe the question is, are we interested in fixing these tests? Are we using tests here anyway?

thanks for sharing an opinion :)

Note: I left out from this patch some lints failures because they involve Rust code and I suspect it's just not linting

Rendered

[rustbot]

r? @jieyouxu

rustbot has assigned @jieyouxu.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

[jieyouxu]

I think if they help with better codeblock hinting (or avoiding trying to use Rust syntax highlighting for non-Rust snippets), it seems fine

So maybe the question is, are we interested in fixing these tests? Are we using tests here anyway?

Note that AFAIK none of these are tests, and are only codeblocks for stylistic/illustrative reasons.

[jieyouxu]

Nit: this is actually md or markdown, right?

[jieyouxu]

Nit: this is more like text?

[jieyouxu]

Remark: I usually use bash for these, not that it really matters, I think

[tshepang]

bash (or sh) gives these wrong highlighting... I would say it should only be used for shell snippets, not command invocations

I would console (as done here) or text them

[jieyouxu]

Nit: these are probably better as text, because they're rustbot github comments

[jieyouxu]

(BTW, what does console actually correspond to?)

[apiraino]

(BTW, what does console actually correspond to?)

MDbook uses Highlight.js and it seems to be just an alias for shell
https://github.com/highlightjs/highlight.js/blob/main/SUPPORTED_LANGUAGES.md

console is the most used in our book so I just stuck to that 🤷‍♂️

$ rg -I "\`\`\`shell" | tr -d "^$" | wc
      7       7      63
$ rg -I "\`\`\`console" | tr -d "^$" | wc
     22      22     242
$ rg -I "\`\`\`bash" | tr -d "^$" | wc
      2       2      16

[apiraino]

I think if they help with better codeblock hinting (or avoiding trying to use Rust syntax highlighting for non-Rust snippets), it seems fine

Yes, that's also my understanding (i.e. cosmetic linting)

[jieyouxu]

Yes, that's also my understanding (i.e. cosmetic linting)

Alright, the changes in this PR seems fine in that case. Just wanted to note that I don't think we're running mdbook test on the Forge book nor was that ever intended AFAIK.