Menu

#784 Improve error message handling

v1.1.x
closed
v1.1.5
Change Request
2023-02-18
2023-02-05
Erik Hänel
No

The information of error messages are mostly distributed over the whole error message and therefore hard to understand. Apply the following changes:

  • If a line information is present, jump to the corresponding line in the editor (at least supply an option to do so). It might also be helpful to add the error message as inline annotation, which will disappear e.g. after saving).
  • Change the structure of an error message into the following:
    1. Start with a summary
    2. Gather the necessary information for error location
    3. Add a explainatory description (Instead of creating new language identifiers, we'll use the line break for separation)
    4. Remove the script abortion part as the important information is already in 2.
  • Reduce the amount of red styled text to reduce the optical noise. It might be enough to colour lines and headlines read and leave the remaining text in standard colour.

Analysis:

Should be implemented as described by the analysis. Will need some major changes in the error handling to actually gather the necessary position information. We won't change th colour as completely red is kind of a de-facto industry standard.

Implementation:

  • Implementation: Implemented as proposed by description and analysis. We did not implement the error annotations as that might be better implemented using EOL annotations, which are not yet available in our version of Scintilla.
  • Revision: [r1322]
  • Implementation test: Different error messages were provoked and did show up as expected.

Documentation:

  • [x] ChangesLog updated
  • [x] Code changes commented
  • Documentation articles:
    • [ ] corresponding documentation articles updated
    • [ ] new documentation articles created
    • [x] not needed
  • Language files:
    • [x] corresponding language files updated
    • [ ] not needed

Tests:

This change was tested manually. No deviation detected.

Related

Commit: [r1322]

Discussion

  • Erik Hänel

    Erik Hänel - 2023-02-05
    • labels: --> internal, errorhandling
    • status: open --> accepted
     
  • Erik Hänel

    Erik Hänel - 2023-02-07
    • Description has changed:

    Diff:

    --- old
    +++ new
    @@ -7,3 +7,25 @@
    
         3.  Add a explainatory description (Instead of creating new language identifiers, we'll use the line break for separation)
         4.  Remove the script abortion part as the important information is already in 2.
     * Reduce the amount of red styled text to reduce the optical noise. It might be enough to colour lines and headlines read and leave the remaining text in standard colour.
    +
    +###Analysis:
    +(*Describe, what's the issue and which changes have to be made*)
    +
    +###Implementation:
    +* Implementation: (*Describe, what you've changed*) 
    +* Revision: [rXXX]
    +* Implementation test: (*Describe the type of test, which you performed, and if it was successful*)
    +
    +###Documentation:
    +* [ ] ChangesLog updated
    +* [ ] Code changes commented
    +* **Documentation articles:**
    +    * [ ] corresponding documentation articles updated
    +    * [ ] new documentation articles created
    +    * [ ] not needed
    +* **Language files:**
    +    * [ ] corresponding language files updated
    +    * [ ] not needed
    +
    +###Tests:
    +(*Describe, which tests you performed and their outcome*)
    
    • status: accepted --> analyzing
     
  • Erik Hänel

    Erik Hänel - 2023-02-08
    • Description has changed:

    Diff:

    --- old
    +++ new
    @@ -9,7 +9,7 @@
    
     * Reduce the amount of red styled text to reduce the optical noise. It might be enough to colour lines and headlines read and leave the remaining text in standard colour.
    
     ###Analysis:
    -(*Describe, what's the issue and which changes have to be made*)
    +Should be implemented as described by the analysis. Will need some major changes in the error handling to actually gather the necessary position information. We won't change th colour as completely red is kind of a de-facto industry standard.
    
     ###Implementation:
    
     * Implementation: (*Describe, what you've changed*) 
    
    • status: analyzing --> implementing
     
  • Erik Hänel

    Erik Hänel - 2023-02-10
    • Description has changed:

    Diff:

    --- old
    +++ new
    @@ -12,19 +12,19 @@
     Should be implemented as described by the analysis. Will need some major changes in the error handling to actually gather the necessary position information. We won't change th colour as completely red is kind of a de-facto industry standard.
    
     ###Implementation:
    -* Implementation: (*Describe, what you've changed*) 
    -* Revision: [rXXX]
    -* Implementation test: (*Describe the type of test, which you performed, and if it was successful*)
    +* Implementation: Implemented as proposed by description and analysis. We did not implement the error annotations as that might be better implemented using EOL annotations, which are not yet available in our version of Scintilla.
    +* Revision: [r1322]
    +* Implementation test: Different error messages were provoked and did show up as expected.
    
     ###Documentation:
    -* [ ] ChangesLog updated
    -* [ ] Code changes commented
    +* [x] ChangesLog updated
    +* [x] Code changes commented
    
     * **Documentation articles:**
         * [ ] corresponding documentation articles updated
         * [ ] new documentation articles created
    -    * [ ] not needed
    +    * [x] not needed
     * **Language files:**
    -    * [ ] corresponding language files updated
    +    * [x] corresponding language files updated
         * [ ] not needed
    
     ###Tests:
    
    • status: implementing --> testing
     

    Related

    Commit: [r1322]

  • Erik Hänel

    Erik Hänel - 2023-02-18
    • Description has changed:

    Diff:

    --- old
    +++ new
    @@ -28,4 +28,4 @@
    
         * [ ] not needed
    
     ###Tests:
    -(*Describe, which tests you performed and their outcome*)
    +This change was tested manually. No deviation detected.
    
    • status: testing --> closed
     

Anonymous
Anonymous

Add attachments
Cancel