Menu ▾ ▴

#295 Improve argument names as function arguments

v1.1.x
closed
Erik Hänel
None
v1.1.0
Change Request
2018-04-25
2018-03-16
Erik Hänel
No

The arguments in the standard functions parentheses are mostly something like STRING or x or P, e.g. strfnd(STR1,STR2,P). This "type" specifier are useless, if one wants to get an information on the purpose of a specific function argument. Change that to something like STRING => sToFind or P => nPos, e.g. strfnd(sToFind,sWhere,nPos).

Analysis:
This can be done completely in the language files. However, it might make more sense, if one keeps sticking to x, y and z and only change the information for the other arguments.

Implementation:
The position of the linebreaks in list -func had to be adapted, because the argument lists of the functions were growing. Implementation tests were passed successfully.

Documentation:
The language files were adapted correspondingly.

Tests:
The tooltips are now much more informative. Change implemented successfully.

Discussion

  • Erik Hänel

    Erik Hänel - 2018-03-16
    • status: open --> accepted
     

  • Erik Hänel

    Erik Hänel - 2018-03-17
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1 +1,9 @@
 The arguments in the standard functions parentheses are mostly something like `STRING` or `x` or `P`, e.g. `strfnd(STR1,STR2,P)`. This "type" specifier are useless, if one wants to get an information on the purpose of a specific function argument. Change that to something like `STRING => sToFind` or `P => nPos`, e.g. `strfnd(sToFind,sWhere,nPos)`.
+
+**Analysis:**
+
+**Implementation:**
+
+**Documentation:**
+
+**Tests:**
    • status: accepted --> analyzing
     

  • Erik Hänel

    Erik Hänel - 2018-03-17
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1,6 +1,7 @@
 The arguments in the standard functions parentheses are mostly something like `STRING` or `x` or `P`, e.g. `strfnd(STR1,STR2,P)`. This "type" specifier are useless, if one wants to get an information on the purpose of a specific function argument. Change that to something like `STRING => sToFind` or `P => nPos`, e.g. `strfnd(sToFind,sWhere,nPos)`.

 **Analysis:**
+This can be done completely in the language files. However, it might make more sense, if one keeps sticking to `x`, `y` and `z` and only change the information for the other arguments.

 **Implementation:**
    • status: analyzing --> implementing
     

  • Erik Hänel

    Erik Hänel - 2018-03-18
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -4,7 +4,9 @@
 This can be done completely in the language files. However, it might make more sense, if one keeps sticking to `x`, `y` and `z` and only change the information for the other arguments.

 **Implementation:**
+The position of the linebreaks in `list -func` had to be adapted, because the argument lists of the functions were growing. Implementation tests were passed successfully.

 **Documentation:**
+The language files were adapted correspondingly.

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

  • Erik Hänel

    Erik Hänel - 2018-04-25
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -10,3 +10,4 @@
 The language files were adapted correspondingly.

 **Tests:**
+The tooltips are now much more informative. Change implemented successfully.
    • status: testing --> closed
     

Anonymous
Anonymous

Add attachments
Cancel





MongoDB Logo MongoDB