You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
"Add missing parameters to ABAPDoc" rules for unit-test methods #103
just to be sure, the idea would be to add an option suppressing this rule in the context of FOR TESTING methods? (Or even FOR TESTING classes as a whole, so it wouldn't run on helper methods in those classes, either?)
If this is not specific to test code versus product code, this option would help:
I would rather skip the rule for aunit methods instead of providing an option. I don't think any one would like to document exceptions for aunit methods.
alright, this will be changed with the next release, meaning that no ABAP Doc line is added for exceptions of test methods. Nevertheless, if exceptions are already documented,
existing ABAP Doc lines are kept if the exceptions are still raised
they are removed if the exception was removed
their order is aligned.
Instead of an option, I added some documentation …
… so if someone comes up with convincing arguments why they need this, we could still add an option for it at a later point in time.
Activity
jmgrassau commentedon Sep 7, 2023
Hi Suhas,
just to be sure, the idea would be to add an option suppressing this rule in the context of FOR TESTING methods? (Or even FOR TESTING classes as a whole, so it wouldn't run on helper methods in those classes, either?)
If this is not specific to test code versus product code, this option would help:
Kind regards,
Jörg-Michael
suynwa commentedon Sep 8, 2023
Hi Jörg-Michael,
I would rather skip the rule for aunit methods instead of providing an option. I don't think any one would like to document exceptions for aunit methods.
In case some one wants to document these exceptions, (s)he can use the ADT quickfix (Ctrl+1) "Add missing parameters to documentation".
KR,
Suhas
jmgrassau commentedon Sep 22, 2023
Hi Suhas,
alright, this will be changed with the next release, meaning that no ABAP Doc line is added for exceptions of test methods. Nevertheless, if exceptions are already documented,
Instead of an option, I added some documentation …
… so if someone comes up with convincing arguments why they need this, we could still add an option for it at a later point in time.
Kind regards,
Jörg-Michael
change AbapDocParametersRule behavior for test methods (SAP#103)
change AbapDocParametersRule behavior for test methods (#103)
jmgrassau commentedon Sep 22, 2023
Hi Suhas,
thanks again for this issue – this is now included in version 1.5.4 which was just released!
Kind regards,
Jörg-Michael