Menu ▾ ▴

#582 Documentation index needs some cleaning-up

v1.1.x
fixed
Erik Hänel
None
v1.1.2
Bug Fix
2021-07-12
2021-05-08
Erik Hänel
No

The documentation index needs some cleaning-up as it repeats index entries multiple times. It seems that this is related to the idxkey tag of the index file.

Analysis:

The corresponding code sections have to be adapted to evaluate comma-separated lists as separate keys using e.g. getAllArguments() to separate the lists.

Implementation:

  • Implementation: The fix was applied as proposed by the analysis.
  • Revision: [r872]
  • Implementation test: The documentation index was displayed using the documentation viewer. No duplicates have been detected.

Documentation:

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

Tests:

As the documentation index has been removed in [#592], this fix does not need any tests.

Related

Commit: [r872]
Tickets: #592

Discussion

  • Erik Hänel

    Erik Hänel - 2021-05-15
    • status: open --> accepted
     

  • Erik Hänel

    Erik Hänel - 2021-05-15
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1 +1,23 @@
 The documentation index needs some cleaning-up as it repeats index entries multiple times. It seems that this is related to the `idxkey` tag of the index file.
+
+###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 - 2021-05-16
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1,7 +1,7 @@
 The documentation index needs some cleaning-up as it repeats index entries multiple times. It seems that this is related to the `idxkey` tag of the index file.

 ###Analysis:
-(*Describe, what's the issue and which changes have to be made*)
+The corresponding code sections have to be adapted to evaluate comma-separated lists as separate keys using e.g. `getAllArguments()` to separate the lists.

 ###Implementation:

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

  • Erik Hänel

    Erik Hänel - 2021-05-16
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -4,20 +4,20 @@
 The corresponding code sections have to be adapted to evaluate comma-separated lists as separate keys using e.g. `getAllArguments()` to separate the lists.

 ###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 fix was applied as proposed by the analysis.
+* Revision: [r872]
+* Implementation test: The documentation index was displayed using the documentation viewer. No duplicates have been detected.

 ###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
-    * [ ] not needed
+    * [x] not needed

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

    Related

    Commit: [r872]

  • Erik Hänel

    Erik Hänel - 2021-07-12
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -20,4 +20,4 @@

     * [x] not needed

 ###Tests:
-(*Describe, which tests you performed and their outcome*)
+As the documentation index has been removed in [#592], this fix does not need any tests.
    • status: testing --> fixed
     

    Related

    Tickets: #592

Anonymous
Anonymous

Add attachments
Cancel





MongoDB Logo MongoDB