Menu ▾ ▴

#176 Create a new documentation interface

v1.1.x
closed
Erik Hänel
None
v1.1.0
Change Request
2017-05-05
2017-03-14
Erik Hänel
No

The function widget allows displaying the corresponding documentation article. However, this is currently realized by a hidden call to help COMMAND. A new interface for this call is needed to avoid the interaction with the console (should not be too difficult).

Analysis:
This needs an interface function taking the desired command name and a new Settings object containing the information that the output in an external viewer is desired. The kernel interface function NumeReKernel::setDocumentation() also needs to be intercepted, as it probably will redirect the generated article to the default output.

Implementation:
The change was implemented by separating the HTML part from the original documentation function so that it can be called separately. By adding a thread-safe interface it's now possible to call documentation articles from the top window.

Documentation:
Not needed. Internal interface.

Tests:
Durability tests were passed without any deviation. Change was implemented successfully.

Discussion

  • Erik Hänel

    Erik Hänel - 2017-03-14
    • status: open --> accepted
     

  • Erik Hänel

    Erik Hänel - 2017-03-14
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1 +1,9 @@
 The function widget allows displaying the corresponding documentation article. However, this is currently realized by a hidden call to `help COMMAND`. A new interface for this call is needed to avoid the interaction with the console (should not be too difficult).
+
+**Analysis:**
+
+**Implementation:**
+
+**Documentation:**
+
+**Tests:**
    • status: accepted --> analyzing
     

  • Erik Hänel

    Erik Hänel - 2017-03-14
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1,6 +1,7 @@
 The function widget allows displaying the corresponding documentation article. However, this is currently realized by a hidden call to `help COMMAND`. A new interface for this call is needed to avoid the interaction with the console (should not be too difficult).

 **Analysis:**
+This needs an interface function taking the desired command name and a new Settings object containing the information that the output in an external viewer is desired. The kernel interface function `NumeReKernel::setDocumentation()` also needs to be intercepted, as it probably will redirect the generated article to the default output.

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

  • Erik Hänel

    Erik Hänel - 2017-03-15
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -4,7 +4,9 @@
 This needs an interface function taking the desired command name and a new Settings object containing the information that the output in an external viewer is desired. The kernel interface function `NumeReKernel::setDocumentation()` also needs to be intercepted, as it probably will redirect the generated article to the default output.

 **Implementation:**
+The change was implemented by separating the HTML part from the original documentation function so that it can be called separately. By adding a thread-safe interface it's now possible to call documentation articles from the top window.

 **Documentation:**
+Not needed. Internal interface.

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

  • Erik Hänel

    Erik Hänel - 2017-05-05
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -10,3 +10,4 @@
 Not needed. Internal interface.

 **Tests:**
+Durability tests were passed without any deviation. Change was implemented successfully.
    • status: testing --> closed
     

Anonymous
Anonymous

Add attachments
Cancel





MongoDB Logo MongoDB