Skip to content

Feature Request: Remove \ when 2 spaces in documentation or comment #181

Open
@emakaay

Description

@emakaay

Hello,

I came across some robot code which had the following construction in documentation and/or comments
[documentation] this function \ adds two numbers, and return \ sum
The only reason these \ are here is to prevent that part of documentation (or comment) is seen as an extra argument. I think in 99.9 % of the cases only a single space is required(and the \ is obsolete).

There could be a transformator(RemoveObsoleteSpacesInDocumentsOrComments) that removes these \ signs. Making documentation and comment more readable.

In the case the backslash is required, there is already some mechanics in place to skip transforming files. The only problem remains when 1 file contains 2 keywords for instance. In 1 method there is a required \ character, and in another method it can be removed.

What do you think ?

Activity

emakaay

emakaay commented on Aug 19, 2021

@emakaay
Author

I Would like to add, this is a minor issue in the code.
Other transformers should get attention first. No hurry at all

bhirsz

bhirsz commented on Aug 23, 2021

@bhirsz
Member

Thank you for feature request. It looks simple to implement. I will do some research to see if it will be easy to find cases when \ is necessary and when \ is not needed and can be removed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @bhirsz@emakaay

        Issue actions

          Feature Request: Remove \ when 2 spaces in documentation or comment · Issue #181 · MarketSquare/robotframework-tidy