Changeset 1014 for framspy

Timestamp:

07/16/20 15:10:12 (4 years ago)

Author:

Maciej Komosinski

Message:

Added more details to docs

File:

• framspy/FramsticksCLI.py (modified) (2 diffs)

framspy/FramsticksCLI.py

@@ -138 +138 @@
                         self.child.expect('\r\n' if os.name == "nt" else '\n')
                         msg = str(self.child.before)
-                        if self.PRINT_FRAMSTICKS_OUTPUT or msg.startswith("[ERROR]"):
+                        if self.PRINT_FRAMSTICKS_OUTPUT or msg.startswith("[ERROR]") or msg.startswith("[CRITICAL]"):
                                 print(msg)
                         if until_marker in msg:
@@ -182 +182 @@
 
         def sendDirectCommand(self, command: str) -> str:
-                """Sends any command to Framsticks CLI. Use when you know Framsticks and its scripting language, Framscript."""
+                """Sends any command to Framsticks CLI. Use when you know Framsticks and its scripting language, Framscript.
+
+                Returns:
+                        The output of the command, likely with extra \\n because for each entered command, Framsticks CLI responds with a (muted in Quiet mode) prompt and a \\n.
+                """
                 self.child.sendline(command.strip())
                 next(FramsticksCLI.sendDirectCommand_counter)