Add Documentation regarding ArchRule priority#1671
Merged
Conversation
hankem
reviewed
Jul 23, 2026
hankem
reviewed
Jul 23, 2026
hankem
reviewed
Jul 23, 2026
Member
Author
|
Thanks for the feedback @hankem. I updated the JavaDoc based on your suggestions. |
hankem
reviewed
Jul 24, 2026
TheManWhoStaresAtCode
force-pushed
the
feature/1633_improve_priority_documentation
branch
from
July 24, 2026 12:34
8eae0dd to
2f02151
Compare
hankem
reviewed
Jul 24, 2026
TheManWhoStaresAtCode
force-pushed
the
feature/1633_improve_priority_documentation
branch
from
July 24, 2026 20:46
2f02151 to
bf6e08d
Compare
hankem
approved these changes
Jul 24, 2026
…Priority enum Signed-off-by: Andreas Zöller <andreas.zoeller@tngtech.com>
hankem
force-pushed
the
feature/1633_improve_priority_documentation
branch
from
July 24, 2026 21:05
bf6e08d to
10ee77f
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
As pointed out in #1633 we lack documentation how to configure the ArchRule priority.
Besides updating the userguide I also added JavaDoc for the priority enum. It might be beneficial to also add JavaDoc to the ArchRuleDefinition method
prioritiesto support IDE users. However I think this should be a dedicated task where we document all public methods of that class or even all of the language package.