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.

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

Rename JobResult to JobOutput #31

Closed
plastikfan opened this issue Aug 21, 2023 · 0 comments · Fixed by #32
Closed

Rename JobResult to JobOutput #31

plastikfan opened this issue Aug 21, 2023 · 0 comments · Fixed by #32
Assignees
Labels
refactor Refactor code

Comments

@plastikfan
Copy link
Contributor

plastikfan commented Aug 21, 2023

The problem with using the name JobResult is that it's difficult for client code to instantiate it with a sensible name. Eg in extendio, we already have the abstraction called TraverseResult so if we try to create a related type we end up with something like:

TraverseResultJobResult

Which doesn't feel right. If we rename JobResult to JobOutput then we can rename the above to be

TraverseResultJobOutput

Which is a vast improvement.

So the worker pool should never use the term Result in it type names as this is such a natural term for the client to use.

@plastikfan plastikfan added the refactor Refactor code label Aug 21, 2023
@plastikfan plastikfan self-assigned this Aug 21, 2023
@plastikfan plastikfan linked a pull request Aug 21, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactor Refactor code
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant