Skip to content

SKException consistency with docs/decisions/0004-error-handling.md#2428

Merged
dsgrieve merged 7 commits intomicrosoft:experimental-javafrom
dsgrieve:dsgrieve/skexception-consistency
Aug 16, 2023
Merged

SKException consistency with docs/decisions/0004-error-handling.md#2428
dsgrieve merged 7 commits intomicrosoft:experimental-javafrom
dsgrieve:dsgrieve/skexception-consistency

Conversation

@dsgrieve
Copy link
Copy Markdown
Contributor

@dsgrieve dsgrieve commented Aug 11, 2023

Motivation and Context

Where it makes sense, align Java with https://github.com/microsoft/semantic-kernel/blob/main/docs/decisions/0004-error-handling.md

Description

For the most part, Java is in compliance with the decision record. This PR tries to make SKException and its inheritors consistent with each other in that each exception has a ErrorCodes enum and an ErrorCodes member with a getter, that the enums use upper case with underscore, and that the formatting of the error message is consistent. This also tries to address "Unnecessary and verbose exceptions", but there was not much to be gained there.

Contribution Checklist

@shawncal shawncal added the java Issue or PR regarding Java code label Aug 11, 2023
@shawncal shawncal changed the title Dsgrieve/skexception consistency Java: Dsgrieve/skexception consistency Aug 11, 2023
@dsgrieve dsgrieve changed the title Java: Dsgrieve/skexception consistency SKException consistency with docs/decisions/0004-error-handling.md Aug 11, 2023
@dsgrieve dsgrieve linked an issue Aug 11, 2023 that may be closed by this pull request
@dsgrieve dsgrieve marked this pull request as ready for review August 14, 2023 19:13
@dsgrieve dsgrieve requested a review from a team as a code owner August 14, 2023 19:13
@dsgrieve dsgrieve merged commit 756236f into microsoft:experimental-java Aug 16, 2023
@dsgrieve dsgrieve deleted the dsgrieve/skexception-consistency branch August 16, 2023 14:29
johnoliver pushed a commit to johnoliver/semantic-kernel that referenced this pull request Jun 5, 2024
…icrosoft#2428)

### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->
Where it makes sense, align Java with
https://github.com/microsoft/semantic-kernel/blob/main/docs/decisions/0004-error-handling.md

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->
For the most part, Java is in compliance with the decision record. This
PR tries to make SKException and its inheritors consistent with each
other in that each exception has a ErrorCodes enum and an ErrorCodes
member with a getter, that the enums use upper case with underscore, and
that the formatting of the error message is consistent. This also tries
to address "Unnecessary and verbose exceptions", but there was not much
to be gained there.

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄
johnoliver pushed a commit to johnoliver/semantic-kernel that referenced this pull request Jun 5, 2024
…icrosoft#2428)

### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->
Where it makes sense, align Java with
https://github.com/microsoft/semantic-kernel/blob/main/docs/decisions/0004-error-handling.md

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->
For the most part, Java is in compliance with the decision record. This
PR tries to make SKException and its inheritors consistent with each
other in that each exception has a ErrorCodes enum and an ErrorCodes
member with a getter, that the enums use upper case with underscore, and
that the formatting of the error message is consistent. This also tries
to address "Unnecessary and verbose exceptions", but there was not much
to be gained there.

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

java Issue or PR regarding Java code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Java: API - Consistency on where Exceptions are located

4 participants