docs(ci): Update generated docs - b53527c [skip ci]

obsproject · Jan 19, 2024 · 5e3fff7 · 5e3fff7
1 parent b53527c
commit 5e3fff7
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 9 deletions.
diff --git a/docs/generated/protocol.json b/docs/generated/protocol.json
@@ -1788,9 +1788,9 @@
       ]
     },
     {
-      "description": "Gets an array of all hotkey names in OBS",
+      "description": "Gets an array of all hotkey names in OBS.\n\nNote: Hotkey functionality in obs-websocket comes as-is, and we do not guarantee support if things are broken. In 9/10 usages of hotkey requests, there exists a better, more reliable method via other requests.",
       "requestType": "GetHotkeyList",
-      "complexity": 3,
+      "complexity": 4,
       "rpcVersion": "1",
       "deprecated": false,
       "initialVersion": "5.0.0",
@@ -1805,9 +1805,9 @@
       ]
     },
     {
-      "description": "Triggers a hotkey using its name. See `GetHotkeyList`",
+      "description": "Triggers a hotkey using its name. See `GetHotkeyList`.\n\nNote: Hotkey functionality in obs-websocket comes as-is, and we do not guarantee support if things are broken. In 9/10 usages of hotkey requests, there exists a better, more reliable method via other requests.",
       "requestType": "TriggerHotkeyByName",
-      "complexity": 3,
+      "complexity": 4,
       "rpcVersion": "1",
       "deprecated": false,
       "initialVersion": "5.0.0",
@@ -1833,7 +1833,7 @@
       "responseFields": []
     },
     {
-      "description": "Triggers a hotkey using a sequence of keys.",
+      "description": "Triggers a hotkey using a sequence of keys.\n\nNote: Hotkey functionality in obs-websocket comes as-is, and we do not guarantee support if things are broken. In 9/10 usages of hotkey requests, there exists a better, more reliable method via other requests.",
       "requestType": "TriggerHotkeyByKeySequence",
       "complexity": 4,
       "rpcVersion": "1",

diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md
@@ -2807,9 +2807,11 @@ If a plugin or script implements vendor requests or events, documentation is exp
 
 ### GetHotkeyList
 
-Gets an array of all hotkey names in OBS
+Gets an array of all hotkey names in OBS.
 
-- Complexity Rating: `3/5`
+Note: Hotkey functionality in obs-websocket comes as-is, and we do not guarantee support if things are broken. In 9/10 usages of hotkey requests, there exists a better, more reliable method via other requests.
+
+- Complexity Rating: `4/5`
 - Latest Supported RPC Version: `1`
 - Added in v5.0.0
 
@@ -2823,9 +2825,11 @@ Gets an array of all hotkey names in OBS
 
 ### TriggerHotkeyByName
 
-Triggers a hotkey using its name. See `GetHotkeyList`
+Triggers a hotkey using its name. See `GetHotkeyList`.
 
-- Complexity Rating: `3/5`
+Note: Hotkey functionality in obs-websocket comes as-is, and we do not guarantee support if things are broken. In 9/10 usages of hotkey requests, there exists a better, more reliable method via other requests.
+
+- Complexity Rating: `4/5`
 - Latest Supported RPC Version: `1`
 - Added in v5.0.0
 
@@ -2842,6 +2846,8 @@ Triggers a hotkey using its name. See `GetHotkeyList`
 
 Triggers a hotkey using a sequence of keys.
 
+Note: Hotkey functionality in obs-websocket comes as-is, and we do not guarantee support if things are broken. In 9/10 usages of hotkey requests, there exists a better, more reliable method via other requests.
+
 - Complexity Rating: `4/5`
 - Latest Supported RPC Version: `1`
 - Added in v5.0.0