Menu ▾ ▴

#717 'read' should also remove comment blocks

v1.1.x
closed
Erik Hänel
cmd (19) internal (109)
v1.1.4
Change Request
2022-08-05
2022-06-18
Erik Hänel
No

The command read should also detect and remove comment blocks. Enhance the syntax by allowing something like read FILE -comments={"LC", "BCS", "BCE"}, where LC means line comment, BCS block-comment-start and BCE is block-comment-end. The internal logic might use the StyledTextFile class.

Analysis:

Can be implemented as described within the description.

Implementation:

  • Implementation: Implemented as proposed by the description.
  • Revision: [r1192]
  • Implementation test: A NumeRe procedure file was read using the new options and the block comments were omitted.

Documentation:

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

Tests:

Change was added to the automatic SW tests. No deviations detected.

Related

Commit: [r1192]

Discussion

  • Erik Hänel

    Erik Hänel - 2022-06-18
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1 +1 @@
-The command `read` should also detect and remove comment blocks. Enhance the syntax by allowing something like `read FILE -comments={"LC", "BCS", "BCE"}`, where `LC` means line comment, `BCS` block-comment-start and `BCE` is block-comment-end.
+The command `read` should also detect and remove comment blocks. Enhance the syntax by allowing something like `read FILE -comments={"LC", "BCS", "BCE"}`, where `LC` means line comment, `BCS` block-comment-start and `BCE` is block-comment-end. The internal logic might use the `StyledTextFile` class.
     

  • Erik Hänel

    Erik Hänel - 2022-07-21
    • labels: --> cmd, internal
    • status: open --> accepted
     

  • Erik Hänel

    Erik Hänel - 2022-07-21
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1 +1,23 @@
 The command `read` should also detect and remove comment blocks. Enhance the syntax by allowing something like `read FILE -comments={"LC", "BCS", "BCE"}`, where `LC` means line comment, `BCS` block-comment-start and `BCE` is block-comment-end. The internal logic might use the `StyledTextFile` class.
+
+###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-07-22
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1,7 +1,7 @@
 The command `read` should also detect and remove comment blocks. Enhance the syntax by allowing something like `read FILE -comments={"LC", "BCS", "BCE"}`, where `LC` means line comment, `BCS` block-comment-start and `BCE` is block-comment-end. The internal logic might use the `StyledTextFile` class.

 ###Analysis:
-(*Describe, what's the issue and which changes have to be made*)
+Can be implemented as described within the description.

 ###Implementation:

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

  • Erik Hänel

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

    Diff:

    --- old
+++ new
@@ -4,20 +4,20 @@
 Can be implemented as described within the description.

 ###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 description.
+* Revision: [r1192]
+* Implementation test: A NumeRe procedure file was read using the new options and the block comments were omitted.

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

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

    Related

    Commit: [r1192]

  • Erik Hänel

    Erik Hänel - 2022-08-05
    • Description has changed:

    Diff:

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

     * [x] not needed

 ###Tests:
-(*Describe, which tests you performed and their outcome*)
+Change was added to the automatic SW tests. No deviations detected.
    • status: testing --> closed
     

Anonymous
Anonymous

Add attachments
Cancel





MongoDB Logo MongoDB