Menu ▾ ▴

#283 Enhance the tooltip information for commands

v1.1.x
closed
Erik Hänel
None
v1.1.1
Change Request
2018-03-01
2018-02-16
Erik Hänel
No

The tool tip information available for most commands is quite poor. Enhance this, so that it contains more information.

Analysis:
The description of the tooltips should at least name the syntax elements and describe their usage. This means as well that the possibilities of the parameters is described in principle, e.g. "read NM [-PAR] Reads the content of the file NM and returns its lines as separate strings. The parameter PAR allows defining a comment character sequence. Binary files cannot be read with this command". In addition, the description should not talk about "calling a function for something". Last but not least it would be helpful, if the commands, which are returning something, which can be stored to a variable, would contain this information in their tooltip just like functions, e.g. "read NM [-PAR] -> {STR} Reads the content ...".

Implementation:
Implementation part is identical to the documentation part.

Documentation:
The language files were adapted correspondingly so that the tooltips now show more and reasonable information about the functionality of commands.

Tests:
The tests for this change are corresponding to language checks. No deviations detected. Change implemented successfully.

Discussion

  • Erik Hänel

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

  • Erik Hänel

    Erik Hänel - 2018-02-20
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1 +1,9 @@
 The tool tip information available for most commands is quite poor. Enhance this, so that it contains more information.
+
+**Analysis:**
+
+**Implementation:**
+
+**Documentation:**
+
+**Tests:**
    • status: accepted --> analyzing
     

  • Erik Hänel

    Erik Hänel - 2018-02-21
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1,6 +1,7 @@
 The tool tip information available for most commands is quite poor. Enhance this, so that it contains more information.

 **Analysis:**
+The description of the tooltips should at least name the syntax elements and describe their usage. This means as well that the possibilities of the parameters is described in principle, e.g. "`read  NM [-PAR]  Reads the content of the file NM and returns its lines as separate strings. The parameter PAR allows defining a comment character sequence. Binary files cannot be read with this command`". In addition, the description should not talk about "calling a function for something". Last but not least it would be helpful, if the commands, which are returning something, which can be stored to a variable, would contain this information in their tooltip just like functions, e.g. "`read  NM [-PAR] -> {STR}  Reads the content ...`". 

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

  • Erik Hänel

    Erik Hänel - 2018-02-23
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -4,7 +4,9 @@
 The description of the tooltips should at least name the syntax elements and describe their usage. This means as well that the possibilities of the parameters is described in principle, e.g. "`read  NM [-PAR]  Reads the content of the file NM and returns its lines as separate strings. The parameter PAR allows defining a comment character sequence. Binary files cannot be read with this command`". In addition, the description should not talk about "calling a function for something". Last but not least it would be helpful, if the commands, which are returning something, which can be stored to a variable, would contain this information in their tooltip just like functions, e.g. "`read  NM [-PAR] -> {STR}  Reads the content ...`". 

 **Implementation:**
+Implementation part is identical to the documentation part.

 **Documentation:**
+The language files were adapted correspondingly so that the tooltips now show more and reasonable information about the functionality of commands.

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

  • Erik Hänel

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

    Diff:

    --- old
+++ new
@@ -10,3 +10,4 @@
 The language files were adapted correspondingly so that the tooltips now show more and reasonable information about the functionality of commands.

 **Tests:**
+The tests for this change are corresponding to language checks. No deviations detected. Change implemented successfully.
    • status: testing --> closed
     

Anonymous
Anonymous

Add attachments
Cancel





MongoDB Logo MongoDB