Menu ▾ ▴

#536 Refactor code for old commands

v1.1.x
closed
Erik Hänel
None
v1.1.2
Change Request
2020-11-11
2020-09-26
Erik Hänel
No

Refactor the code for hist, stats and random, because it is a very old and ineffective coding style.

Analysis:

The following actions have to be done for a minimal rework:

  • hist: Separate the code into multiple functions, at least calculation, plotting and output for 1 and 2D. Think of a more "modern" output like writing to a new table
  • stats: Separate calculation and output, think of a more "modern" output like writing to a new table
  • random: This command needs a bit of refactoring, but is not as outdated than the other two commands

Implementation:

  • Implementation: The change was processed as indicated by the analysis.
  • Revision: [r777]-[r781]
  • Implementation test: All commands functionalities were tested manually.

Documentation:

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

Tests:

Change request was added to the automatic tests. Remaining deviation was fixed with [r786].

Related

Commit: [r777]
Commit: [r781]
Commit: [r786]

Discussion

  • Erik Hänel

    Erik Hänel - 2020-10-18
    • status: open --> accepted
     

  • Erik Hänel

    Erik Hänel - 2020-10-19
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1 +1,23 @@
 Refactor the code for `hist`, `stats` and `random`, because it is a very old and ineffective coding style.
+
+###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 - 2020-10-19
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1,7 +1,11 @@
 Refactor the code for `hist`, `stats` and `random`, because it is a very old and ineffective coding style.

 ###Analysis:
-(*Describe, what's the issue and which changes have to be made*)
+The following actions have to be done for a minimal rework:
+
+* `hist`: Separate the code into multiple functions, at least calculation, plotting and output for 1 and 2D. Think of a more "modern" output like writing to a new table
+* `stats`: Separate calculation and output, think of a more "modern" output like writing to a new table
+* `random`: This command needs a bit of refactoring, but is not as outdated than the other two commands

 ###Implementation:

 * Implementation: (*Describe, what you've changed*)
    • status: analyzing --> implementing
     

  • Erik Hänel

    Erik Hänel - 2020-10-31
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -8,19 +8,19 @@

 * `random`: This command needs a bit of refactoring, but is not as outdated than the other two commands

 ###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:  The change was processed as indicated by the analysis. 
+* Revision: [r777]-[r781]
+* Implementation test: All commands functionalities were tested manually.

 ###Documentation:
-* [ ] ChangesLog updated
-* [ ] Code changes commented
+* [x] ChangesLog updated
+* [x] Code changes commented

 * **Documentation articles:**
-    * [ ] corresponding documentation articles updated
+    * [x] corresponding documentation articles updated
     * [ ] new documentation articles created
     * [ ] not needed
 * **Language files:**
-    * [ ] corresponding language files updated
+    * [x] corresponding language files updated
     * [ ] not needed

 ###Tests:
    • status: implementing --> testing
     

    Related

    Commit: [r777]
    Commit: [r781]

  • Erik Hänel

    Erik Hänel - 2020-11-11
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -24,4 +24,4 @@

     * [ ] not needed

 ###Tests:
-(*Describe, which tests you performed and their outcome*)
+Change request was added to the automatic tests. Remaining deviation was fixed with [r786].
    • status: testing --> closed
     

    Related

    Commit: [r786]

Anonymous
Anonymous

Add attachments
Cancel





MongoDB Logo MongoDB