If # character is in Documentation it is automatically changed-reformated

Hello

When a RF file opened with RIDE its documentation parts (Documentation and [Documentation]) that contain ‘#’ character are automatically changed. All characters from ‘#’ until the end of the line are removed from place and appended to the 1st line of Documentation or [Documentation] they are inside. If there are more than one lines they are appended also.

Example This KW

No Doc
    [Documentation]    
    ...
    ...    # # char in KW documentation
    No Operation

is transformed to this:

No Doc
    [Documentation]    \    # # char in KW documentation
    No Operation

Affects v2.0b2.dev5 (before and after the fix for #2433)

I include some additional testing examples (as code here because I had problems uploading them as file). I’m not sure if all usages of ‘#’ as code line comment I include in example are correct.

*** Settings ***
Documentation     Library contains Keywords to read configuration files
...
...               | `Normalize Text` |
...
...               # # char in suite documentation
...               \# Escaped # char in suite documentation
...
...               Examples:
...               | ${text1} | Normalize TextId | Text | # Suite documentation 'inline comment' |
Resource          JSON_reader.resource    # Resource comment


*** Variables ***
${NoKeyError}     Error:NoKeyError    # Variable comment

*** Keywords ***
Normalize Text
    [Arguments]    ${text}    ${keepspaces}=${False}
    [Documentation]    Normalizes the given TextId
    ...
    ...    # # char in KW documentation
    ...    \# Escaped # char in suite documentation
    ...
    ...    Examples:
    ...    | ${text1} | Normalize TextId | Text | # KW documentation 'inline comment' 1 |
    ...    | ${text3} | Normalize TextId | \ \ text \ \ | # KW documentation 'inline comment' 2 |
    ...    | ${text5} | Normalize TextId | te xt | keepspaces=${True} | # KW documentation 'inline comment' 3 |
    ${normText}    Set Variable If    ${keepspaces}    1    2    # KW code inline comment 1
    # KW code line comment in single cell
    #    KW code line comment with text in 2nd cell
    \# NOT KW code line comment because # is escaped
    IF    '${LOG_LEVEL}' == 'DEBUG'
        Log    '${text}' -> '${normText}'    level=DEBUG    # KW code inline comment 2
        Log    '${text}' -> '${normText}'    level=DEBUG        # KW code inline comment after 1 empty cell
    END
    [Return]    ${normText}

No Doc
    [Documentation]    
    ...
    ...    # # char in KW documentation
    No Operation

[irapths]

Hello @HelioGuilherme66 and THANK YOU VERY MUCH about all the effort of maintaining RIDE

In my company we all use RIDE as main editor and execute Test from inside it and from command line (windows) and Jenkins (Linux), but never had any deprecation warning as you mention. To be honest I’m not even aware of the deprecation of continuing line marker (…) resolved to empty line inside the Documentation.

So I simplify the above example as bellow, in order to focus on the main issue.

Code in file (RIDE 1.7.4.2 running on Python 3.7.9)

No Doc
    [Documentation]    Doc
    ...    | A table with | # char |
    No Operation

Code in editor (RIDE v2.0b2.dev5 running on Python 3.7.9. )

No Doc
    [Documentation]    Doc    # char |
    ...    | A table with |
    No Operation

Code in GUI documentation editor window (RIDE v2.0b2.dev5 running on Python 3.7.9. )

Doc
| A table with |

I use dev version of RIDE v2.0 the last 1.5 years and since v2.0b2.dev4 I was created with it many RF files with lot of “empty documentation lines (…)”, tables in documentations with ‘#’ in them and use ‘#’ as inline comment (in the very last cell of a code line). I personally don’t like/use ‘"’ for code line comments and I prefer the “Comment” KW instead, but other Co-Workers do (all use the 2.0dev2 version). (We try to remove ALL comments with ‘#’ but needs lot of time and effort and we are not there yet)

Until yesterday (v2.0b2.dev4) all files were loaded as they were stored and any update was written/saved as it was seen in editor, in “documentation editor window” and “documentation field”.

After updating to v2.0b2.dev5 I have to check for unwanted changes on files before every commit and revert them. I’m really OK with, for now, this since it is my choice to use dev versions of RIDE 😃 , but this not disappears the issue.

[HelioGuilherme66]

@irapths Can you please test from current master (2.0b3.dev2)?