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

move getMessage to meta_data? #124

Open
andre-merzky opened this issue Mar 26, 2021 · 1 comment
Open

move getMessage to meta_data? #124

andre-merzky opened this issue Mar 26, 2021 · 1 comment
Assignees
Labels
enhancement New feature or request question Further information is requested

Comments

@andre-merzky
Copy link
Collaborator

Is your request related to a problem? Please describe.
I am find the usage of the status message attribute unclear / unclean. (a) according to @hategan, it is supposed to convey error messages on FAILED states - but that means that the field is only usable in that state. But also, (b), I consider the meta_data dict to be the catch-all for any non-standardized, backend specific information, and an error message would fit that bill.

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
remove Status.getMessage.

Additional context
I am uncertain about this - this may be more a request for clarification / discussion than for immediate change. Maybe making the name clearer (getMessage -> getError) would also work, to make the intent and scope clear.

@andre-merzky andre-merzky added enhancement New feature or request question Further information is requested labels Mar 26, 2021
@hategan
Copy link
Collaborator

hategan commented Aug 5, 2023

Would renaming it to getErrorMessage make more sense?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants