Skip to content

docs(SnippetChoiceReason): Improve OTHER comment #11150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tsteenbe wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(SnippetChoiceReason): Improve OTHER comment #11150

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion model/src/main/kotlin/config/snippet/SnippetChoiceReason.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ enum class SnippetChoiceReason {
ORIGINAL_FINDING,

/**
* Other reason.
* Any other reason which cannot be represented by any other element of [SnippetChoiceReason].
Copy link
Member

@sschuberth sschuberth Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Maybe "by the further entries of [SnippetChoiceReason]"? (To avoid duplication of "any" and to not explain "OTHER" with "other (elements)").

Copy link
Member Author

@tsteenbe tsteenbe Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

Copy link
Member

@sschuberth sschuberth Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

*/
OTHER
}
Loading