Skip to content

Improve documentation of slices rules #1454

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.

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

Merged
merged 1 commit into from
May 7, 2025
Merged

Conversation

hankem
Copy link
Member

@hankem hankem commented May 4, 2025

The user guide's slices documentation had a comment that didn't perfectly match the code:

// checks all subpackages of 'myapp' for cycles
SlicesRuleDefinition.slices().matching("..myapp.(**)").should().notDependOnEachOther()

In addition, the involved methods could use some more JavaDoc:

Signed-off-by: Manfred Hanke <Manfred.Hanke@tngtech.com>
@hankem hankem changed the title improve documentation of slices rules Improve documentation of slices rules May 4, 2025
Copy link
Collaborator

@codecholeric codecholeric left a comment

Choose a reason for hiding this comment

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

Thanks for taking care of this 🙂

@codecholeric codecholeric merged commit 4b53612 into main May 7, 2025
27 checks passed
@codecholeric codecholeric deleted the slices-documentation branch May 7, 2025 19:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants