Menu ▾ ▴

#748 Update function documentation in language files

v1.1.x
closed
Erik Hänel
documentation (9) language (4)
v1.1.5
Change Request
2023-02-16
2022-10-18
Erik Hänel
No

Go through the function language strings and convert mode descriptions to an itemized list as well as change the parameters to a boolean, if they are boolean, e.g. getfilelist(sScheme,withPaths=false)

Analysis:

Nothing really difficult to be carried out. The syntax of itemized lists can be found in e.g. in the documentation of textparse(). Go through all language strings in numere.nlng and check those for the boolean default values and possible itemized lists.

Implementation:

  • Implementation: Changes made as described above.
    The following items were adapted with itemize commands:basetodec(), cmp(), cutoff(), getfilelist(), getfolderlist(), getindices(), ivl(), justify(), strunique(), unique(), test.rankof(), test.typeof()
  • Revision: [r451] (lang repo only)
  • Implementation test: Tested each entry in the German version by hovering over the syntax element.

Documentation:

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

Tests:

No test necessary. Only reviewed the current situation and found no deviation.

Related

Commit: [r451]

Discussion

  • Erik Hänel

    Erik Hänel - 2022-10-18
    • labels: --> documentation, language
    • status: open --> accepted
     

  • Erik Hänel

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

    Diff:

    --- old
+++ new
@@ -1 +1,23 @@
 Go through the function language strings and convert mode descriptions to an itemized list as well as change the parameters to a boolean, if they are boolean, e.g. `getfilelist(sScheme,withPaths=false)`
+
+###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-11-12
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1,7 +1,7 @@
 Go through the function language strings and convert mode descriptions to an itemized list as well as change the parameters to a boolean, if they are boolean, e.g. `getfilelist(sScheme,withPaths=false)`

 ###Analysis:
-(*Describe, what's the issue and which changes have to be made*)
+Nothing really difficult to be carried out. The syntax of itemized lists can be found in e.g. in the documentation of `textparse()`. Go through all language strings in `numere.nlng` and check those for the boolean default values and possible itemized lists.

 ###Implementation:

 * Implementation: (*Describe, what you've changed*)
    • status: analyzing --> implementing
    • assigned_to: Erik Hänel --> Raphael Zehner
     

  • Raphael Zehner

    Raphael Zehner - 2022-11-24
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -4,9 +4,9 @@
 Nothing really difficult to be carried out. The syntax of itemized lists can be found in e.g. in the documentation of `textparse()`. Go through all language strings in `numere.nlng` and check those for the boolean default values and possible itemized 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: Changes made as described above. 
+* Revision: [r451] (lang repo only)
+* Implementation test: Tested each entry in the German version by hovering over the syntax element.

 ###Documentation:

 * [ ] ChangesLog updated
@@ -14,9 +14,9 @@
 * **Documentation articles:**
     * [ ] corresponding documentation articles updated
     * [ ] new documentation articles created
-    * [ ] not needed
+    * [x] not needed
 * **Language files:**
-    * [ ] corresponding language files updated
+    * [x] corresponding language files updated
     * [ ] not needed

 ###Tests:
    • status: implementing --> testing
    • assigned_to: Raphael Zehner --> Erik Hänel
     

    Related

    Commit: [r451]

  • Raphael Zehner

    Raphael Zehner - 2022-11-24
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -5,6 +5,7 @@

 ###Implementation:

 * Implementation: Changes made as described above. 
+        The following items were adapted with itemize commands:basetodec(), cmp(), cutoff(), getfilelist(), getfolderlist(), getindices(), ivl(), justify(), strunique(), unique(), test.rankof(), test.typeof()
 * Revision: [r451] (lang repo only)
 * Implementation test: Tested each entry in the German version by hovering over the syntax element.
     

    Related

    Commit: [r451]

  • Erik Hänel

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

    Diff:

    --- old
+++ new
@@ -21,4 +21,4 @@

     * [ ] not needed

 ###Tests:
-(*Describe, which tests you performed and their outcome*)
+No test necessary. Only reviewed the current situation and found no deviation.
    • status: testing --> closed
     

Anonymous
Anonymous

Add attachments
Cancel





MongoDB Logo MongoDB