Skip to content

Commit

Permalink
Clarified Slices documentation
Browse files Browse the repository at this point in the history
The slices documentation does not mention a very important aspect, that is that, technically, Slices do not represent a given set of packages, although the example shows that.

Signed-off-by: mipo256 <mikhailpolivakha@gmail.com>
  • Loading branch information
mipo256 committed Jan 17, 2025
1 parent f8f80de commit a44cfb0
Showing 1 changed file with 5 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@
* com.mycompany.myapp.user
* com.mycompany.myapp.authorization
* </code></pre>
* <p>
* Note that a {@link Slice} does not necessarily represent a subpackage inside some root package.
* The example above is just a common use case, but a {@link Slice} can technically represent any set
* of {@link JavaClass}es.
* <p>
* The top level packages under 'myapp' could be considered slices according to different domain aspects.<br>
* Thus there could be a slice 'Order' housing all the classes from the {@code order} package, a slice 'Customer'
* housing all the classes from the {@code customer} package and so on.
Expand Down

0 comments on commit a44cfb0

Please sign in to comment.