MarketSquare / MarketSquare/robotframework-tidy
Feature Request: Remove \ when 2 spaces in documentation or comment
- Dominant language
- RobotFramework
- Stars
- 113
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
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 ?
Contributor guide
Research direction
The issue names no files, tests, or entry points. Start by locating the existing mechanics for skipping backslash transformation, then assess how a per-method decision would work when one file contains both required and removable backslashes; done means obsolete backslashes are removed without changing required ones.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100