Menu ▾ ▴

#352 Create more informative error messages for the resampler/Smoothing

v1.1.x
closed
Erik Hänel
None
v1.1.0
Change Request
2018-11-10
2018-06-21
Erik Hänel
No

The error messaging of the resampler and the smoothing algorithm is not informative. Create more detailed error messages.

Analysis:

The error messaging of the smoothing functionality may be easily enhanced. There's only one special case for smooth, which is not related to standard errors like SyntaxError::INVALID_INDEX. This means, that the error message for smooth has to be enhanced and that every return false has to be replaced by throw SyntaxError(...).

For the resampler there are more possibilities of error sources. These have to be added to the SyntaxError object itself. Additionally, the new error strings have to be provided. Because the resampler used dynamic memory allocation, additional try ... catch blocks have to be added.

Implementation:

  • Implementation: The change was done as proposed by the analysis. One single new error message was created
  • Revision: [r364]
  • Implementation test: Errors were provoked and where thrown as expected.

Documentation:

  • ChangesLog: updated
  • Comments: Code was commented sufficiently
  • Documentation articles: not needed - internal change
  • Language files: Error message language files were updated accordingly

Tests:

This change was tested thoroughly in production tests. All deviations were resolved.

Related

Commit: [r364]

Discussion

  • Erik Hänel

    Erik Hänel - 2018-06-24
    • status: open --> accepted
     

  • Erik Hänel

    Erik Hänel - 2018-06-27
    • summary: Create more informative error messages for the resampler --> Create more informative error messages for the resampler/Smoothing
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1 +1 @@
-The error messaging of the resampler is not informative. Create more detailed error messages.
+The error messaging of the resampler and the smoothing algorithm is not informative. Create more detailed error messages.
     

  • Erik Hänel

    Erik Hänel - 2018-07-25
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1 +1,17 @@
 The error messaging of the resampler and the smoothing algorithm is not informative. Create more detailed error messages.
+
+###Analysis:
+(*Describe, what's the issue and which changes have to be made*)
+
+###Implementation:
+* Implementation: (*Describe, what you've changed*)
+* Implementation test: (*Describe the type of test, which you performed, and if it was succesful*)
+
+###Documentation:
+* ChangesLog: (*Have you updated the changes log?*)
+* Comments: (*Have you written comments in the code, which describe your change?*)
+* Documentation articles: (*Have you updated the documentation articles?*)
+* Language files: (*Have you updated the language files?*)
+
+###Tests:
+(*Describe, which tests you performed and their outcome*)
    • status: accepted --> analyzing
     

  • Erik Hänel

    Erik Hänel - 2018-07-26
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1,10 +1,13 @@
 The error messaging of the resampler and the smoothing algorithm is not informative. Create more detailed error messages.

 ###Analysis:
-(*Describe, what's the issue and which changes have to be made*)
+The error messaging of the smoothing functionality may be easily enhanced. There's only one special case for `smooth`, which is not related to standard errors like `SyntaxError::INVALID_INDEX`. This means, that the error message for `smooth` has to be enhanced and that every `return false` has to be replaced by `throw SyntaxError(...)`.
+
+For the resampler there are more possibilities of error sources. These have to be added to the `SyntaxError` object itself. Additionally, the new error strings have to be provided. Because the resampler used dynamic memory allocation, additional `try ... catch` blocks have to be added.

 ###Implementation:

 * Implementation: (*Describe, what you've changed*)
+* Revision: [rXXX]
 * Implementation test: (*Describe the type of test, which you performed, and if it was succesful*)

 ###Documentation:
    • status: analyzing --> implementing
     

  • Erik Hänel

    Erik Hänel - 2018-07-26
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -6,15 +6,15 @@
 For the resampler there are more possibilities of error sources. These have to be added to the `SyntaxError` object itself. Additionally, the new error strings have to be provided. Because the resampler used dynamic memory allocation, additional `try ... catch` blocks have to be added.

 ###Implementation:
-* Implementation: (*Describe, what you've changed*)
-* Revision: [rXXX]
-* Implementation test: (*Describe the type of test, which you performed, and if it was succesful*)
+* Implementation: The change was done as proposed by the analysis. One single new error message was created
+* Revision: [r364]
+* Implementation test: Errors were provoked and where thrown as expected.

 ###Documentation:
-* ChangesLog: (*Have you updated the changes log?*)
-* Comments: (*Have you written comments in the code, which describe your change?*)
-* Documentation articles: (*Have you updated the documentation articles?*)
-* Language files: (*Have you updated the language files?*)
+* ChangesLog: updated
+* Comments: Code was commented sufficiently
+* Documentation articles: not needed - internal change
+* Language files: Error message language files were updated accordingly

 ###Tests:
 (*Describe, which tests you performed and their outcome*)
    • status: implementing --> testing
     

    Related

    Commit: [r364]

  • Erik Hänel

    Erik Hänel - 2018-11-10
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -17,4 +17,4 @@

 * Language files: Error message language files were updated accordingly

 ###Tests:
-(*Describe, which tests you performed and their outcome*)
+This change was tested thoroughly in production tests. All deviations were resolved.
    • status: testing --> closed
     

Anonymous
Anonymous

Add attachments
Cancel





MongoDB Logo MongoDB