Skip to content
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

Jump to bottom

Add and enhance JavaDoc for the new Unit of Work #2966

Open
smcvb opened this issue Jan 24, 2024 · 0 comments
Open

Add and enhance JavaDoc for the new Unit of Work #2966

smcvb opened this issue Jan 24, 2024 · 0 comments
Assignees
@smcvb
Labels
Priority 1: Must Highest priority. A release cannot be made if this issue isn’t resolved. Type: Enhancement Use to signal an issue enhances an already existing feature of the project.
Milestone
Release 5.0.0

Comments

@smcvb
Copy link
Member

smcvb commented Jan 24, 2024

Enhancement Description

The new Unit of Work, as introduced in #2953, still requires a bunch of JavaDoc to be put in place.
This work is done separately to unblock further development that's already pending on several branches.

Furthermore, #2953 deprecates several classes, which also require documentation.
Lastly, we should update the axon-5/api-changes.md file to explain this pretty massive breaking change for users!

Current Behaviour

There is some documentation in the newly introduced ProcesingContext, ProcessingLifecycle, and AsyncUnitOfWork`.

Wanted Behaviour

The documentation in the newly introduced ProcesingContext, ProcessingLifecycle, and AsyncUnitOfWork` is complete and clear.

Possible Workarounds

None, this simply is a must.
@smcvb smcvb added Type: Enhancement Use to signal an issue enhances an already existing feature of the project. Priority 1: Must Highest priority. A release cannot be made if this issue isn’t resolved. labels Jan 24, 2024
@smcvb smcvb added this to the Release 5.0.0 milestone Jan 24, 2024
@smcvb smcvb self-assigned this Jan 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@smcvb smcvb

Labels
Priority 1: Must Highest priority. A release cannot be made if this issue isn’t resolved. Type: Enhancement Use to signal an issue enhances an already existing feature of the project.
Projects
None yet
Milestone
Release 5.0.0
Development

No branches or pull requests
1 participant
@smcvb