docs(core): fix UseCase docstring example to use output DTO#932
Merged
Conversation
The example showed UseCase[..., Task] returning a Task entity, but every concrete use case returns an output DTO (TaskOperationOutput, etc.). Update the example to match the DTO-return convention. Closes #877
![amazon-q-developer[bot]](https://avatars.githubusercontent.com/in/1220912?s=60&v=4){kind=small}
There was a problem hiding this comment.
The docstring update correctly aligns the example with the current DTO-return convention used throughout the codebase. The changes are accurate and improve documentation clarity for contributors.
You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.
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
1 participant
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.
Summary
The docstring example in the
UseCasebase class showedUseCase[..., Task]returning aTaskentity, but every concrete use case returns an output DTO (TaskOperationOutput,TaskUpdateOutput,StatusChangeOutput, etc.). This was a leftover from an earlier refactor (entities → output DTOs) and could mislead new contributors into breaking the controller-layer contract.Updated the example to match the current DTO-return convention.
Test plan
Closes #877