Menu ▾ ▴

#776 Section detection has problems, if empty lines are removed

v1.1.x
fixed
Erik Hänel
gui (58) editor (22)
v1.1.4
Bug Fix
2023-02-16
2022-12-22
Erik Hänel
No

If the section detection is active and one adds an empty line in a documentation section, the following documentation line is detected as a new section. If this line is removed again, the marker does not disappear any more. Should be resolved.

Analysis:

Can be done in the usual sectioning algorithm, where we simply delete all markers in the currently jumped documentation block.

Implementation:

  • Implementation: Implemented as proposed by the analysis.
  • Revision: [r1288]
  • Implementation test: An empty line was added to a documentation block, the additional section appeared and disappeared again after the line was removed again.

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:

Fix was tested manually. No deviation detected.

Related

Commit: [r1288]

Discussion

  • Erik Hänel

    Erik Hänel - 2022-12-22
    • labels: --> gui, editor
    • status: open --> accepted
     

  • Erik Hänel

    Erik Hänel - 2022-12-22
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1 +1,23 @@
 If the section detection is active and one adds an empty line in a documentation section, the following documentation line is detected as a new section. If this line is removed again, the marker does not disappear any more. Should be resolved.
+
+###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 - 2022-12-22
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1,7 +1,7 @@
 If the section detection is active and one adds an empty line in a documentation section, the following documentation line is detected as a new section. If this line is removed again, the marker does not disappear any more. Should be resolved.

 ###Analysis:
-(*Describe, what's the issue and which changes have to be made*)
+Can be done in the usual sectioning algorithm, where we simply delete all markers in the currently jumped documentation block.

 ###Implementation:

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

  • Erik Hänel

    Erik Hänel - 2022-12-22
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -4,20 +4,20 @@
 Can be done in the usual sectioning algorithm, where we simply delete all markers in the currently jumped documentation block.

 ###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 the analysis.
+* Revision: [r1288]
+* Implementation test: An empty line was added to a documentation block, the additional section appeared and disappeared again after the line was removed again.

 ###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: [r1288]

  • Erik Hänel

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

    Diff:

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

     * [x] not needed

 ###Tests:
-(*Describe, which tests you performed and their outcome*)
+Fix was tested manually. No deviation detected.
    • status: testing --> fixed
     

Anonymous
Anonymous

Add attachments
Cancel





MongoDB Logo MongoDB