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

Powderhouse error proposal #2374

Open
wants to merge 1 commit into
base: main-powderhouse
Choose a base branch
from

Conversation

KathleenDollard
Copy link
Contributor

Proposal for the shape of Powderhouse errors and an overview of usage.

@KathleenDollard KathleenDollard changed the base branch from main to main-powderhouse April 10, 2024 14:45
Copy link

@JeanJoeris JeanJoeris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this broadly makes sense. Left 2 nits and a question

## API

* `CliDiagnosticDescriptor`
*`string DiagnosticId`

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Needs a space between * and `

* `CliError`
* `public string DiagnosticId`
* `public Location Location` (which includes Symbol and Text to allow messages to be what user typed)
* `public string? Message` (defaults to Diagnostic)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unsure but I think you might mean (defaults to DefaultMessage) rather than (defaults to Diagnostic)

Comment on lines +23 to +25
### `ErrorSubsystem`

Errors will be managed and reported via the ErrorSubsystem. This is to allow errors to be easily added by any subsystem. This might be preprocessing, execution, or optionally by an uncaught exception. Addition of errors by invocations is supported, to allow consistent reporting of errors.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this proposal for ErrorSubsystem makes sense. Curious if you think my PR for an initial pass at ErrorSubsystem should be merged first then implement this proposal or vice-versa?

@KathleenDollard KathleenDollard added the Powderhouse Work to isolate parser and features label Apr 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Powderhouse Work to isolate parser and features
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

2 participants