Description
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 commentedon Aug 19, 2021
I Would like to add, this is a minor issue in the code.
Other transformers should get attention first. No hurry at all
bhirsz commentedon Aug 23, 2021
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.