Updated source docu.

Wed, 29 Apr 2020 18:36:16 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Wed, 29 Apr 2020 18:36:16 +0200
changeset 7555
24f1bb4c78a3
parent 7554
97da2ac22807
child 7556
87e1a76933fc

Updated source docu.

eric6/APIs/Python3/eric6.api file | annotate | diff | comparison | revisions
eric6/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.DebugClients.Python.DebugClientBase.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.DebugClients.Python.getpass.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.MicroPython.MicrobitDevices.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/index-eric6.MicroPython.html file | annotate | diff | comparison | revisions
--- a/eric6/APIs/Python3/eric6.api	Wed Apr 29 18:35:30 2020 +0200
+++ b/eric6/APIs/Python3/eric6.api	Wed Apr 29 18:36:16 2020 +0200
@@ -319,7 +319,7 @@
 eric6.DebugClients.Python.DebugClientBase.DebugClientBase?1()
 eric6.DebugClients.Python.DebugClientBase.DebugClientClose?4(fd)
 eric6.DebugClients.Python.DebugClientBase.DebugClientFork?4()
-eric6.DebugClients.Python.DebugClientBase.DebugClientInput?4(prompt="", echo=True)
+eric6.DebugClients.Python.DebugClientBase.DebugClientInput?4(prompt="")
 eric6.DebugClients.Python.DebugClientBase.DebugClientInstance?7
 eric6.DebugClients.Python.DebugClientBase.DebugClientRawInput?4(prompt="", echo=True)
 eric6.DebugClients.Python.DebugClientBase.DebugClientSetRecursionLimit?4(limit)
@@ -411,6 +411,7 @@
 eric6.DebugClients.Python.eric6dbgstub.setScriptname?4(name)
 eric6.DebugClients.Python.eric6dbgstub.startDebugger?4(enableTrace=True, exceptions=True, tracePython=False, redirect=True)
 eric6.DebugClients.Python.getpass.default_getpass?7
+eric6.DebugClients.Python.getpass.fallback_getpass?7
 eric6.DebugClients.Python.getpass.getpass?4(prompt='Password: ')
 eric6.DebugClients.Python.getpass.getuser?4()
 eric6.DebugClients.Python.getpass.unix_getpass?7
@@ -2429,7 +2430,7 @@
 eric6.MicroPython.MicrobitDevices.MicrobitDevice.hasTimeCommands?4()
 eric6.MicroPython.MicrobitDevices.MicrobitDevice.runScript?4(script)
 eric6.MicroPython.MicrobitDevices.MicrobitDevice.setButtons?4()
-eric6.MicroPython.MicrobitDevices.MicrobitDevice?1(microPythonWidget, parent=None)
+eric6.MicroPython.MicrobitDevices.MicrobitDevice?1(microPythonWidget, deviceType, parent=None)
 eric6.MicroPython.PyBoardDevices.PyBoardDevice.DeviceVolumeName?7
 eric6.MicroPython.PyBoardDevices.PyBoardDevice.FlashInstructionsURL?7
 eric6.MicroPython.PyBoardDevices.PyBoardDevice.addDeviceMenuEntries?4(menu)
Binary file eric6/Documentation/Help/source.qch has changed
--- a/eric6/Documentation/Source/eric6.DebugClients.Python.DebugClientBase.html	Wed Apr 29 18:35:30 2020 +0200
+++ b/eric6/Documentation/Source/eric6.DebugClients.Python.DebugClientBase.html	Wed Apr 29 18:36:16 2020 +0200
@@ -53,11 +53,11 @@
 </tr>
 <tr>
 <td><a href="#DebugClientInput">DebugClientInput</a></td>
-<td>Replacement for the standard input builtin.</td>
+<td>Replacement for the standard input() builtin (Python 2).</td>
 </tr>
 <tr>
 <td><a href="#DebugClientRawInput">DebugClientRawInput</a></td>
-<td>Replacement for the standard raw_input builtin.</td>
+<td>Replacement for the standard raw_input() builtin (Python 2) and the standard input() builtin (Python 3).</td>
 </tr>
 <tr>
 <td><a href="#DebugClientSetRecursionLimit">DebugClientSetRecursionLimit</a></td>
@@ -1261,23 +1261,19 @@
 <hr />
 <a NAME="DebugClientInput" ID="DebugClientInput"></a>
 <h2>DebugClientInput</h2>
-<b>DebugClientInput</b>(<i>prompt="", echo=True</i>)
+<b>DebugClientInput</b>(<i>prompt=""</i>)
 
 <p>
-    Replacement for the standard input builtin.
+    Replacement for the standard input() builtin (Python 2).
 </p>
 <p>
     This function works with the split debugger.
 </p>
 <dl>
 
-<dt><i>prompt</i></dt>
+<dt><i>prompt</i> (str)</dt>
 <dd>
-prompt to be shown (string)
-</dd>
-<dt><i>echo</i></dt>
-<dd>
-flag indicating to echo the output (boolean)
+prompt to be shown
 </dd>
 </dl>
 <dl>
@@ -1286,6 +1282,12 @@
 result of the input() call
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
@@ -1294,26 +1296,33 @@
 <b>DebugClientRawInput</b>(<i>prompt="", echo=True</i>)
 
 <p>
-    Replacement for the standard raw_input builtin.
+    Replacement for the standard raw_input() builtin (Python 2) and
+    the standard input() builtin (Python 3).
 </p>
 <p>
     This function works with the split debugger.
 </p>
 <dl>
 
-<dt><i>prompt</i></dt>
+<dt><i>prompt</i> (str)</dt>
 <dd>
-prompt to be shown. (string)
+prompt to be shown
 </dd>
-<dt><i>echo</i></dt>
+<dt><i>echo</i> (bool)</dt>
 <dd>
-flag indicating echoing of the input (boolean)
+flag indicating echoing of the input
 </dd>
 </dl>
 <dl>
 <dt>Returns:</dt>
 <dd>
-result of the raw_input() call
+result of the raw_input()/input() call
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
--- a/eric6/Documentation/Source/eric6.DebugClients.Python.getpass.html	Wed Apr 29 18:35:30 2020 +0200
+++ b/eric6/Documentation/Source/eric6.DebugClients.Python.getpass.html	Wed Apr 29 18:36:16 2020 +0200
@@ -36,7 +36,7 @@
 <h3>Global Attributes</h3>
 
 <table>
-<tr><td>__all__</td></tr><tr><td>default_getpass</td></tr><tr><td>unix_getpass</td></tr><tr><td>win_getpass</td></tr>
+<tr><td>__all__</td></tr><tr><td>default_getpass</td></tr><tr><td>fallback_getpass</td></tr><tr><td>unix_getpass</td></tr><tr><td>win_getpass</td></tr>
 </table>
 <h3>Classes</h3>
 
@@ -67,15 +67,21 @@
 </p>
 <dl>
 
-<dt><i>prompt</i></dt>
+<dt><i>prompt</i> (str)</dt>
 <dd>
-Prompt to be shown to the user (string)
+Prompt to be shown to the user
 </dd>
 </dl>
 <dl>
 <dt>Returns:</dt>
 <dd>
-Password entered by the user (string)
+Password entered by the user
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -95,7 +101,13 @@
 <dl>
 <dt>Returns:</dt>
 <dd>
-username (string)
+username
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
--- a/eric6/Documentation/Source/eric6.MicroPython.MicrobitDevices.html	Wed Apr 29 18:35:30 2020 +0200
+++ b/eric6/Documentation/Source/eric6.MicroPython.MicrobitDevices.html	Wed Apr 29 18:36:16 2020 +0200
@@ -23,7 +23,8 @@
 <h1>eric6.MicroPython.MicrobitDevices</h1>
 
 <p>
-Module implementing the device interface class for BBC micro:bit boards.
+Module implementing the device interface class for BBC micro:bit and
+Calliope mini boards.
 </p>
 <h3>Global Attributes</h3>
 
@@ -36,7 +37,7 @@
 
 <tr>
 <td><a href="#MicrobitDevice">MicrobitDevice</a></td>
-<td>Class implementing the device for BBC micro:bit boards.</td>
+<td>Class implementing the device for BBC micro:bit and Calliope mini boards.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -50,7 +51,7 @@
 <h2>MicrobitDevice</h2>
 
 <p>
-    Class implementing the device for BBC micro:bit boards.
+    Class implementing the device for BBC micro:bit and Calliope mini boards.
 </p>
 <h3>Derived from</h3>
 MicroPythonDevice
@@ -149,7 +150,7 @@
 
 <a NAME="MicrobitDevice.__init__" ID="MicrobitDevice.__init__"></a>
 <h4>MicrobitDevice (Constructor)</h4>
-<b>MicrobitDevice</b>(<i>microPythonWidget, parent=None</i>)
+<b>MicrobitDevice</b>(<i>microPythonWidget, deviceType, parent=None</i>)
 
 <p>
         Constructor
@@ -160,6 +161,10 @@
 <dd>
 reference to the main MicroPython widget
 </dd>
+<dt><i>deviceType</i> (str)</dt>
+<dd>
+type of the device
+</dd>
 <dt><i>parent</i> (QObject)</dt>
 <dd>
 reference to the parent object
--- a/eric6/Documentation/Source/index-eric6.MicroPython.html	Wed Apr 29 18:35:30 2020 +0200
+++ b/eric6/Documentation/Source/index-eric6.MicroPython.html	Wed Apr 29 18:36:16 2020 +0200
@@ -87,7 +87,7 @@
 </tr>
 <tr>
 <td><a href="eric6.MicroPython.MicrobitDevices.html">MicrobitDevices</a></td>
-<td>Module implementing the device interface class for BBC micro:bit boards.</td>
+<td>Module implementing the device interface class for BBC micro:bit and Calliope mini boards.</td>
 </tr>
 <tr>
 <td><a href="eric6.MicroPython.PyBoardDevices.html">PyBoardDevices</a></td>

eric ide

mercurial