Skip to content

"Must" in "Percentage of comments must be lower than 10% of the productive code" #631

@Monikae

Description

@Monikae

Check Name
Comment Usage Check

Actual Behavior
When trying to release a transport request the short text of the warning says e.g.: "Percentage of comments must be lower than 10% of the productive code! (17%>=10%) (3 lines found)"

Expected Behavior
The short text should say: "Percentage of comments should be lower than 10% of the productive code. (17%>=10%) (3 lines found)"

In the long text it's correct: https://github.com/SAP/code-pal-for-abap/blob/master/docs/checks/comment-usage.md , there it says "Perhaps there is no issue and every comment in the code is actually meaningful and necessary. Do not treat findings from this check as issues that need to be "solved" by deleting potentially valuable comments ...".

"Must" has a very clear meaning in the context of e.g. requirement documents and developers will interpret it that way. In the short text it is used incorrectly and needs to be replaced.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working correctly

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions