Merge pull request #1022 from PLuv/develop

Docs Updates
2021-05-29 12:41:10 -04:00
commit fd599c254e
@@ -43,6 +43,11 @@
            "style": "Text",
            "text": "For example, in the open stage, you probably defined the target size as a function of the capital allocated to the trading system. In the close stage, you will likely want to define the target size as a function of the size filled, that is, the amount of the orders placed that was filled during the open stage."
        },
+        {
+            "style": "Text",
+            "text": "In the event that the target size of the asset to be traded in Close Stage is equal to zero then Close Stage will close as will the currently running strategy. For example: Suppose the Open Stage was to trade x amount of quoted asset at y price via a limit order. But instead price moved in the opposite direction and to the point that Open Stage closed prior to the accumulation of any of the Base Asset which was to be traded via the Close Stage. In that scenario Close Stage would not take any action and would Close the current instance of the Strategy and the system would resume polling for another Trigger On event.",
+            "updated": 1622300970890
+        },
        {
            "style": "Include",
            "text": "Superalgos->Topic->Why My Stage is not Closing?->The Stage Does Not Close",
@@ -1,8 +1,8 @@
 {
    "type": "User Defined Code",
    "definition": {
-        "text": "You can use this node to inject your own executable code into the the Trading System. The exact moment when this code will be run depends on its config properties. From your code you can access the Trading Engine, read and modify it's values, modifying the standar behaviour of the Trading Bot.",
-        "updated": 1621988586103
+        "text": "You can use this node to inject your own executable code into the the Trading System. The exact moment when this code will be run depends on its config properties. From your code you can access the Trading Engine, read and modify it's values, modifying the standard behaviour of the Trading Bot.",
+        "updated": 1622299982600
    },
    "paragraphs": [
        {
@@ -0,0 +1,14 @@
+{
+    "type": "User Defined Variable",
+    "definition": {
+        "text": "The User-Defined-Variable is a mutable storage container for whatever arbitrary data the user may want to manage while running a Trading System.",
+        "updated": 1622299578764
+    },
+    "paragraphs": [
+        {
+            "style": "Text",
+            "text": "These variables can be easily set or get by using the Copy Node Path in the node's popup modal.",
+            "updated": 1622299861437
+        }
+    ]
+}
@@ -0,0 +1,33 @@
+{
+    "type": "User Defined Variables",
+    "definition": {
+        "text": "The User Defined Variables node structure is an unused area of the Trading Engine users can access from within their Trading System to store data.",
+        "updated": 1622234154032
+    },
+    "paragraphs": [
+        {
+            "style": "Text",
+            "text": "<h4>Overview</h4>",
+            "updated": 1622299369556
+        },
+        {
+            "style": "Text",
+            "text": "Oftentimes, when building a strategy, the need for a place to store some data may arise. The User-Defined-Variables nodes are the correct place to do this. The children nodes, (User Defined variable nodes), of this node are unused by the base code of the Superalgos processes thus the data placed inside these variables will remain unchanged and available for the duration of the episode."
+        },
+        {
+            "style": "Text",
+            "text": "<h4>Additional Info</h4>",
+            "updated": 1622250099965
+        },
+        {
+            "style": "Text",
+            "text": "- Persistence: It should be noted that these variables will persist throughout the System's episode; not just at the stage or strategy layer from which they are set.",
+            "updated": 1622299441071
+        },
+        {
+            "style": "Text",
+            "text": "- State: A user defined variable is mutable.",
+            "updated": 1622250209793
+        }
+    ]
+}