[BUG] Instead showing an error, show a hint if a variable in documentation setting is not found

[d-biehl]

regarding #46 Do not analyse variables in documentation

robotframework also analyse variables in documentation tags, but do not replace them or shows an error if they where not found.

[d-biehl]

The correct way, if you want to have variables in Documentation or Metadata settings that should not be resolved by robotframework is to escape the variable, this should look like this:

*** Keywords ***
a keyword
    [Documentation]    This is a documentation \@{TEST}
    ...
    ...    Examples:
    ...
    ...    | \${value} | a keyword | \${TEST}    1 |

    Log    Hello from keyword

this prevents wrong documentation, because it was replaced by robotframework, if there is somewhere a variable defined with the same name, let run this short test:

*** Variables ***
${TEST}     hello

*** Test Cases ***
first
    a keyword

*** Keywords ***
a keyword
    [Documentation]    '${TEST}' is the value \${TEST}
    Log    Hello from keyword

in the report you will get something like this:

I will correct this bug so that in documentation a hint occurs instead of an error.

[d-biehl]

fixed in 0.10.1