Skip to content
This repository has been archived by the owner on Jun 28, 2023. It is now read-only.

Improve error reporting #21

Open
RamonMeffert opened this issue Nov 7, 2020 · 4 comments
Open

Improve error reporting #21

RamonMeffert opened this issue Nov 7, 2020 · 4 comments
Assignees
Labels
enhancement New feature or request maybe

Comments

@RamonMeffert
Copy link
Owner

RamonMeffert commented Nov 7, 2020

Instead of the error being just a string, make it a record so the rendering can be improved. Something like:

type alias Error =
    { title : String
    , message : String
    , cause : String
    , advice : String
    }
@RamonMeffert RamonMeffert added this to To Do in Tools for Gossip Nov 7, 2020
@RamonMeffert RamonMeffert self-assigned this Nov 8, 2020
@RamonMeffert
Copy link
Owner Author

Should also have a severity field

@RamonMeffert
Copy link
Owner Author

RamonMeffert commented Nov 8, 2020

  • Also, a 'global' method to render these errors is needed as well

@RamonMeffert RamonMeffert added this to the Meeting Nov 24 milestone Nov 10, 2020
This was referenced Nov 20, 2020
@RamonMeffert RamonMeffert added the enhancement New feature or request label Nov 23, 2020
@RamonMeffert RamonMeffert mentioned this issue Nov 24, 2020
2 tasks
@RamonMeffert
Copy link
Owner Author

Note: errors are pretty neat already, it's just that they could be even better

@RamonMeffert RamonMeffert removed this from the Meeting Nov 24 milestone Dec 15, 2020
@RamonMeffert RamonMeffert added maybe and removed misc labels Dec 17, 2020
@RamonMeffert
Copy link
Owner Author

RamonMeffert commented Dec 17, 2020

Errors are good enough generally, but there are a few cases that could use improvement:

  • A complex input string for gossip graphs has an error. This will generate an error like "Agent X is unknown", leaving the user to manually search for the error in the input string. If possible, it would be nice to show a message like the following:

    Abc aBc abX
              ↑
            here
    
    I do not know agent X! Maybe you meant to include an extra agent, or you made a typo?
    

    I already have the position of the error in the string, so this would (/should) not be too difficult. Will of course only work when using a monospace font.

  • The same issue as above, but for call sequences

  • Maybe more?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request maybe
Projects
No open projects
Development

No branches or pull requests

1 participant