Add error reporting for the new version solver #1785
Merged
Conversation
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
This improves some complex error output
This is useful for formatting human-readable error messages.
This was just the root package's directory, which is always the current working directory anyway.
This makes it possible to produce terse output by default while also providing enough detail to diagnose incompatible sources or descriptions.
|
A thought (for my contrived case) My attempt at tweaks... This is 1000x than what we have now. Feel free to tuck this away as a p2 for later. |
|
@kevmoo What would your proposed output do if the terminal was too narrow to fit the entire first line?
My instinct is that including this level of explanation at every step would make the output in even moderately complex cases a lot more verbose. There comes a point at which explicitness is actually unhelpful because there's so much raw text that peoples eyes gloss over. Is this worth it? |
nex3
force-pushed
the
feature.solver.error
branch
from
f440189 to
d4842cd
Compare
munificent
requested changes
Feb 2, 2018
lib/src/solver/failure.dart
Outdated
| /// | ||
| /// See https://github.com/dart-lang/pub/tree/master/doc/solver.md#error-reporting | ||
| /// for details on how this algorithm works. | ||
| String toString() { |
There was a problem hiding this comment.
This is quite the method! Given that it has state and a number of sub-functions with their own doc comments, I think it's worth moving it out to a separate class that this calls.
lib/src/solver/failure.dart
Outdated
| /// If [incompatibility] is only used to derive one other incompatibility, | ||
| /// it may make sense to skip that derivation and just derive the second | ||
| /// incompatibility directly from three causes. This is usually clear enough | ||
| /// to the user, and makes the proof much terser. |
There was a problem hiding this comment.
Can you give an example? (If that's not easy, feel free to ignore this.)
nex3
commented
Feb 2, 2018
lib/src/solver/failure.dart
Outdated
| /// | ||
| /// See https://github.com/dart-lang/pub/tree/master/doc/solver.md#error-reporting | ||
| /// for details on how this algorithm works. | ||
| String toString() { |
lib/src/solver/failure.dart
Outdated
| /// If [incompatibility] is only used to derive one other incompatibility, | ||
| /// it may make sense to skip that derivation and just derive the second | ||
| /// incompatibility directly from three causes. This is usually clear enough | ||
| /// to the user, and makes the proof much terser. |
munificent
approved these changes
Feb 6, 2018
This helps allow tables conserve horizontal space without affecting readability too drastically.
nex3
force-pushed
the
feature.solver.error
branch
from
cb2f508 to
8c27f03
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.