More release manager guide edits

[thibaultduponchelle]

Changes

• More code snippets in code blocks
• Remove redundant "You MUST SKIP" since =for checklist skip ... and make-rmg-checklist already does the job
• Linear "Bump the version number" with use of =for checklist skip ... to generate correct sections
• More use of 5.X.Y (replaced by make-rmg-checklist by appropriate number)

---

• This set of changes does not require a perldelta entry.

[book]

Personal preference, but I think that 4 spaces stand out more for verbatim test. It's also consistent with Markdown syntax.

[thibaultduponchelle]

Almost all other verbatim are standing out 1 space.

[khwilliamson]

I believe in 1 space verbatim. My vim editor shows it in a different color, making it stand out, without needing extra indentation; I presume other editors do the same. I just looked at blead's RMG using less, and it seemed fine to me.

The real reason to use 1 space indents is to minimize wrapping of lines too long to fit in the terminal width. When this happens it is ugly and hard to read, a far worse outcome in my opinion than indenting fewer spaces. A one-space indent means we've tried our best to keep this from happening, no matter what the terminal width, except if we were to split the line into multiple ones. Sometimes that might be advisable, but in many instances it would make things actually harder for the reader.

The minimum terminal width we claim to try to cater to is 80 columns.

I've encountered more than a few instances where I've added verbatim text that is 80ish columns wide, but will wrap under the prevailing 4 space indent existing in the file. I think it is inconsiderate to future readers to just let it wrap, or to expect that everyone is using a wider terminal width than 80. It's better to make it fit, which means decreasing the indent. But then, this line will not conform to the rest of the file. Do I change the rest of the file at this time? It would be better for that file to have contained a 1-space indent from the beginning. I don't think existing files should be changed because of this prospect, but I do think that any new file should use 1 space verbatim indents.

[ericherman]

This is a very good improvement.