code-pal-for-abap icon indicating copy to clipboard operation
code-pal-for-abap copied to clipboard

`cut` as default

Open lucasborin opened this issue 4 years ago • 3 comments

lucasborin avatar May 14 '21 13:05 lucasborin

@estevao-schultz-neto-SAP: Would you mind reviewing the new documentation?

lucasborin avatar May 14 '21 13:05 lucasborin

image

cut in the method name should be ignored.

lucasborin avatar May 14 '21 17:05 lucasborin

Hello Buddy, I don't think this check should be "enforced" in the sense that someone will need to use the pseudo-comment in case he/she has used a MEANINGFUL name. I think we have a mismatch here. From the text: "...In a test class, the code under the test can be represented using a meaningful name, or cut as a default..." either CUT or a MEANINGFUL name should be accepted. But what is a meaningful name then? Subjective...

Long story short: IMHO, this CHECK will mostly be used as a NOTIFICATION in case someone is not using "cut" (and in case the team agreed so -- team decision).

Moreover, I would change the description so that: _"...In a test class, the code under the test can be represented using a meaningful name or cut as a default. If your team decided to use 'cut', this check can be helpful on identifying deviations.". _

We talk about it further.

All the checks are NOTIFICATION by default so, as you mentioned, it is up to the team to decide if they want to follow cut as the main default or not. The check will just support these ones. Besides, I will enhance the documentation as you mentioned.

lucasborin avatar Jul 07 '21 17:07 lucasborin

Closing this as no longer relevant

bjoern-jueliger-sap avatar Sep 29 '23 13:09 bjoern-jueliger-sap