Pre-formatted blocks in documentation get modified by formatter

[UniqueActive]

Hi!

I saw that Robot Framework supports pre-formatted blocks of text in documentation with this syntax:

*** Settings ***
Documentation    Here is some regular text that should be formatted
...
...              | This pre-formatted text should stay intact
...              |    1.2 <----> 1.2    .--> 1.2
...              |    1.3 <-.    1.3 <-´ ,-> 1.3
...              |    1.4    `-> 1.4    /    1.4
...              |    1.5        1.5 <-´     1.5

However when running the robocop formatter (default settings), the pre-formatted text is modified (last line), I assume because of the >4 spaces:

*** Settings ***
Documentation       Here is some regular text that should be formatted
...
...                 | This pre-formatted text should stay intact
...                 |    1.2 <----> 1.2    .--> 1.2
...                 |    1.3 <-.    1.3 <-´ ,-> 1.3
...                 |    1.4    `-> 1.4    /    1.4
...                 |    1.5    1.5 <-´    1.5

Currently we have to work around this by using # robocop fmt: off for the Documentation.

Thanks in advance!

[bhirsz]

Typically it should be adjust by skip documentation flag, though it usually is enabled by default for all formatters (we avoid formatting the documentation if possible, only on demand). Do you have any non-default formatters enabled? So we could reproduce it.

Also, does setting up global skip on documentation helps? (if not, we are missing skip for some formatter entirely):

robocop format --skip documentation

[UniqueActive]

Hi,

I can reproduce this with default settings and a simple robocop format example.robot. Using --skip documentation works but also leads to the general indentation of the documentation not being aligned with the rest of the *** Settings *** :

*** Settings ***
Documentation       Here is some regular text that should be formatted
...
...                 | This pre-formatted text should stay intact
...                 |    1.2 <----> 1.2    .--> 1.2
...                 |    1.3 <-.    1.3 <-´ ,-> 1.3
...                 |    1.4    `-> 1.4    /    1.4
...                 |    1.5        1.5 <-´     1.5

Library     OperatingSystem

[UniqueActive]

Perhaps a small clarification on what I would expect to happen:

• Settings are aligned with each other (default behaviour)
• Documentation contents are not modified or at least the pre-formatted blocks are not modified

Does that make sense to you?

[bhirsz]

Yes it makes sense. I will analyze it and came back with something - but not in this week or two as I am currently on vacation.

[UniqueActive]

Whenever it works for you, no urgency at all! Thanks for your work! :)