docs(SnippetChoiceReason): Improve OTHER comment
#11150
Conversation
Improve comment for `OTHER` to better explain when it should be selected. Signed-off-by: Thomas Steenbergen <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #11150 +/- ##
=========================================
Coverage 57.41% 57.41%
Complexity 1703 1703
=========================================
Files 346 346
Lines 12839 12839
Branches 1219 1219
=========================================
Hits 7372 7372
Misses 4997 4997
Partials 470 470
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
|
||
| /** | ||
| * Other reason. | ||
| * Any other reason which cannot be represented by any other element of [SnippetChoiceReason]. |
There was a problem hiding this comment.
Nit: Maybe "by the further entries of [SnippetChoiceReason]"? (To avoid duplication of "any" and to not explain "OTHER" with "other (elements)").
There was a problem hiding this comment.
@sschuberth My update comment sentence is a near exact copy of https://github.com/oss-review-toolkit/ort/blob/147b48a/model/src/main/kotlin/config/PathExcludeReason.kt#L55 and https://github.com/oss-review-toolkit/ort/blob/147b48a/model/src/main/kotlin/config/PathIncludeReason.kt#L29 so if we change it here i propose we also change it for those files.
There was a problem hiding this comment.
so if we change it here i propose we also change it for those files.
Yes, I'm all for consistency here. If you agree the proposed wording to be better, maybe just align all three of them in this single commit? I think the commit message already would cover that and could stay unchanged.
See individual commit for details - submitting it after ORT user feedback.