Update python docs with changes from IntelRealSense#3993

python_docs/_generated/pyrealsense2.composite_frame.html

@@ -49,7 +49,7 @@ <h1>pyrealsense2.composite_frame<a class="headerlink" href="#pyrealsense2-compos
 <dl class="class">
 <dt id="pyrealsense2.composite_frame">
 <em class="property">class </em><code class="descclassname">pyrealsense2.</code><code class="descname">composite_frame</code><a class="headerlink" href="#pyrealsense2.composite_frame" title="Permalink to this definition">¶</a></dt>
-<dd><p>Extend frame class with additional frameset related attributes and functions</p>
+<dd><p>Extends the frame class with additional frameset related attributes and functions</p>
 <dl class="method">
 <dt id="pyrealsense2.composite_frame.__init__">
 <code class="descname">__init__</code><span class="sig-paren">(</span><em>self: pyrealsense2.composite_frame</em>, <em>arg0: pyrealsense2.frame</em><span class="sig-paren">)</span> &rarr; None<a class="headerlink" href="#pyrealsense2.composite_frame.__init__" title="Permalink to this definition">¶</a></dt>
@@ -87,22 +87,22 @@ <h1>pyrealsense2.composite_frame<a class="headerlink" href="#pyrealsense2-compos
 <td></td>
 </tr>
 <tr class="row-odd"><td><a class="reference internal" href="#pyrealsense2.composite_frame.first" title="pyrealsense2.composite_frame.first"><code class="xref py py-obj docutils literal"><span class="pre">first</span></code></a>((self:&nbsp;pyrealsense2.composite_frame,&nbsp;...)</td>
-<td>Retrieve the first frame of specific stream type, if no frame found, an error will be thrown.</td>
+<td>Retrieve the first frame of a specific stream type and optionally with a specific format.</td>
 </tr>
 <tr class="row-even"><td><a class="reference internal" href="#pyrealsense2.composite_frame.first_or_default" title="pyrealsense2.composite_frame.first_or_default"><code class="xref py py-obj docutils literal"><span class="pre">first_or_default</span></code></a>(...)</td>
-<td>Retrieve the first frame of specific stream and format types, if no frame found, return the default one.</td>
+<td>Retrieve the first frame of a specific stream and optionally with a specific format.</td>
 </tr>
 <tr class="row-odd"><td><a class="reference internal" href="#pyrealsense2.composite_frame.foreach" title="pyrealsense2.composite_frame.foreach"><code class="xref py py-obj docutils literal"><span class="pre">foreach</span></code></a>((self:&nbsp;pyrealsense2.composite_frame,&nbsp;...)</td>
 <td>Extract internal frame handles from the frameset and invoke the action function</td>
 </tr>
 <tr class="row-even"><td><a class="reference internal" href="#pyrealsense2.composite_frame.get_color_frame" title="pyrealsense2.composite_frame.get_color_frame"><code class="xref py py-obj docutils literal"><span class="pre">get_color_frame</span></code></a>(...)</td>
-<td>Retrieve the first color frame, if no frame found, search the color frame from IR stream.</td>
+<td>Retrieve the first color frame, if no frame is found, search for the color frame from IR stream.</td>
 </tr>
 <tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">get_data</span></code>(...)</td>
 <td>Retrieve data from the frame handle.</td>
 </tr>
 <tr class="row-even"><td><a class="reference internal" href="#pyrealsense2.composite_frame.get_depth_frame" title="pyrealsense2.composite_frame.get_depth_frame"><code class="xref py py-obj docutils literal"><span class="pre">get_depth_frame</span></code></a>(...)</td>
-<td>Retrieve the first depth frame, if no frame found, return the default one.</td>
+<td>Retrieve the first depth frame, if no frame is found, return an empty frame instance.</td>
 </tr>
 <tr class="row-odd"><td><a class="reference internal" href="#pyrealsense2.composite_frame.get_fisheye_frame" title="pyrealsense2.composite_frame.get_fisheye_frame"><code class="xref py py-obj docutils literal"><span class="pre">get_fisheye_frame</span></code></a>(...)</td>
 <td>Retrieve the fisheye monochrome video frame</td>
@@ -117,7 +117,7 @@ <h1>pyrealsense2.composite_frame<a class="headerlink" href="#pyrealsense2-compos
 <td>Retrieve the timestamp domain.</td>
 </tr>
 <tr class="row-odd"><td><a class="reference internal" href="#pyrealsense2.composite_frame.get_infrared_frame" title="pyrealsense2.composite_frame.get_infrared_frame"><code class="xref py py-obj docutils literal"><span class="pre">get_infrared_frame</span></code></a>(...)</td>
-<td>Retrieve the first infrared frame, if no frame found, return the default one (frame instance)</td>
+<td>Retrieve the first infrared frame, if no frame is found, return an empty frame instance.</td>
 </tr>
 <tr class="row-even"><td><a class="reference internal" href="#pyrealsense2.composite_frame.get_pose_frame" title="pyrealsense2.composite_frame.get_pose_frame"><code class="xref py py-obj docutils literal"><span class="pre">get_pose_frame</span></code></a>(*args,&nbsp;**kwargs)</td>
 <td>Overloaded function.</td>
@@ -190,13 +190,13 @@ <h1>pyrealsense2.composite_frame<a class="headerlink" href="#pyrealsense2-compos
 <dl class="method">
 <dt id="pyrealsense2.composite_frame.first">
 <code class="descname">first</code><span class="sig-paren">(</span><em>self: pyrealsense2.composite_frame</em>, <em>s: pyrealsense2.stream</em>, <em>f: pyrealsense2.format=format.any</em><span class="sig-paren">)</span> &rarr; pyrealsense2.frame<a class="headerlink" href="#pyrealsense2.composite_frame.first" title="Permalink to this definition">¶</a></dt>
-<dd><p>Retrieve the first frame of specific stream type, if no frame found, an error will be thrown.</p>
+<dd><p>Retrieve the first frame of a specific stream type and optionally with a specific format. If no frame is found, an error will be thrown.</p>
 </dd></dl>
 
 <dl class="method">
 <dt id="pyrealsense2.composite_frame.first_or_default">
 <code class="descname">first_or_default</code><span class="sig-paren">(</span><em>self: pyrealsense2.composite_frame</em>, <em>s: pyrealsense2.stream</em>, <em>f: pyrealsense2.format=format.any</em><span class="sig-paren">)</span> &rarr; pyrealsense2.frame<a class="headerlink" href="#pyrealsense2.composite_frame.first_or_default" title="Permalink to this definition">¶</a></dt>
-<dd><p>Retrieve the first frame of specific stream and format types, if no frame found, return the default one. (frame instance)</p>
+<dd><p>Retrieve the first frame of a specific stream and optionally with a specific format. If no frame is found, return an empty frame instance.</p>
 </dd></dl>
 
 <dl class="method">
@@ -208,13 +208,13 @@ <h1>pyrealsense2.composite_frame<a class="headerlink" href="#pyrealsense2-compos
 <dl class="method">
 <dt id="pyrealsense2.composite_frame.get_color_frame">
 <code class="descname">get_color_frame</code><span class="sig-paren">(</span><em>self: pyrealsense2.composite_frame</em><span class="sig-paren">)</span> &rarr; pyrealsense2.video_frame<a class="headerlink" href="#pyrealsense2.composite_frame.get_color_frame" title="Permalink to this definition">¶</a></dt>
-<dd><p>Retrieve the first color frame, if no frame found, search the color frame from IR stream. If one still can&#8217;t be found, return the default one. (frame instance)</p>
+<dd><p>Retrieve the first color frame, if no frame is found, search for the color frame from IR stream. If one still can&#8217;t be found, return an empty frame instance.</p>
 </dd></dl>
 
 <dl class="method">
 <dt id="pyrealsense2.composite_frame.get_depth_frame">
 <code class="descname">get_depth_frame</code><span class="sig-paren">(</span><em>self: pyrealsense2.composite_frame</em><span class="sig-paren">)</span> &rarr; rs2::depth_frame<a class="headerlink" href="#pyrealsense2.composite_frame.get_depth_frame" title="Permalink to this definition">¶</a></dt>
-<dd><p>Retrieve the first depth frame, if no frame found, return the default one. (frame instance)</p>
+<dd><p>Retrieve the first depth frame, if no frame is found, return an empty frame instance.</p>
 </dd></dl>
 
 <dl class="method">
@@ -226,7 +226,7 @@ <h1>pyrealsense2.composite_frame<a class="headerlink" href="#pyrealsense2-compos
 <dl class="method">
 <dt id="pyrealsense2.composite_frame.get_infrared_frame">
 <code class="descname">get_infrared_frame</code><span class="sig-paren">(</span><em>self: pyrealsense2.composite_frame</em>, <em>index: int=0</em><span class="sig-paren">)</span> &rarr; pyrealsense2.video_frame<a class="headerlink" href="#pyrealsense2.composite_frame.get_infrared_frame" title="Permalink to this definition">¶</a></dt>
-<dd><p>Retrieve the first infrared frame, if no frame found, return the default one (frame instance)</p>
+<dd><p>Retrieve the first infrared frame, if no frame is found, return an empty frame instance.</p>
 </dd></dl>
 
 <dl class="method">

python_docs/_generated/pyrealsense2.config.html

@@ -138,14 +138,14 @@ <h1>pyrealsense2.config<a class="headerlink" href="#pyrealsense2-config" title="
 <code class="descname">enable_device_from_file</code><span class="sig-paren">(</span><em>self: pyrealsense2.config</em>, <em>file_name: str</em>, <em>repeat_playback: bool=True</em><span class="sig-paren">)</span> &rarr; None<a class="headerlink" href="#pyrealsense2.config.enable_device_from_file" title="Permalink to this definition">¶</a></dt>
 <dd><p>Select a recorded device from a file, to be used by the pipeline through playback.
 The device available streams are as recorded to the file, and resolve() considers only this device and configuration as available.
-This request cannot be used if enable_record_to_file() is called for the current config, and vise versa</p>
+This request cannot be used if enable_record_to_file() is called for the current config, and vice versa.</p>
 </dd></dl>
 
 <dl class="method">
 <dt id="pyrealsense2.config.enable_record_to_file">
 <code class="descname">enable_record_to_file</code><span class="sig-paren">(</span><em>self: pyrealsense2.config</em>, <em>file_name: str</em><span class="sig-paren">)</span> &rarr; None<a class="headerlink" href="#pyrealsense2.config.enable_record_to_file" title="Permalink to this definition">¶</a></dt>
 <dd><p>Requires that the resolved device would be recorded to file.
-This request cannot be used if enable_device_from_file() is called for the current config, and vise versa as available.</p>
+This request cannot be used if enable_device_from_file() is called for the current config, and vice versa as available.</p>
 </dd></dl>
 
 <dl class="method">
@@ -166,19 +166,19 @@ <h1>pyrealsense2.config<a class="headerlink" href="#pyrealsense2-config" title="
 <ol class="arabic simple" start="2">
 <li>enable_stream(self: pyrealsense2.config, stream_type: pyrealsense2.stream, stream_index: int=-1) -&gt; None</li>
 </ol>
-<p>Stream type and possibly also stream index</p>
+<p>Stream type and possibly also stream index. Other parameters are resolved internally.</p>
 <ol class="arabic simple" start="3">
 <li>enable_stream(self: pyrealsense2.config, stream_type: pyrealsense2.stream, format: pyrealsense2.format, framerate: int=0) -&gt; None</li>
 </ol>
-<p>Stream type and format, and possibly frame rate</p>
+<p>Stream type and format, and possibly frame rate. Other parameters are resolved internally.</p>
 <ol class="arabic simple" start="4">
 <li>enable_stream(self: pyrealsense2.config, stream_type: pyrealsense2.stream, width: int, height: int, format: pyrealsense2.format=format.any, framerate: int=0) -&gt; None</li>
 </ol>
-<p>Stream type and resolution, and possibly format and frame rate</p>
+<p>Stream type and resolution, and possibly format and frame rate. Other parameters are resolved internally.</p>
 <ol class="arabic simple" start="5">
 <li>enable_stream(self: pyrealsense2.config, stream_type: pyrealsense2.stream, stream_index: int, format: pyrealsense2.format, framerate: int=0) -&gt; None</li>
 </ol>
-<p>Stream type, index, and format, and possibly framerate</p>
+<p>Stream type, index, and format, and possibly framerate. Other parameters are resolved internally.</p>
 </dd></dl>
 
 <dl class="method">

python_docs/_generated/pyrealsense2.context.html

@@ -75,7 +75,7 @@ <h1>pyrealsense2.context<a class="headerlink" href="#pyrealsense2-context" title
 <td>Generate a flat list of all available sensors from all RealSense devices.</td>
 </tr>
 <tr class="row-odd"><td><a class="reference internal" href="#pyrealsense2.context.query_devices" title="pyrealsense2.context.query_devices"><code class="xref py py-obj docutils literal"><span class="pre">query_devices</span></code></a>(...)</td>
-<td>Create a static snapshot of all connected devices a the time of the call.</td>
+<td>Create a static snapshot of all connected devices at the time of the call.</td>
 </tr>
 <tr class="row-even"><td><a class="reference internal" href="#pyrealsense2.context.set_devices_changed_callback" title="pyrealsense2.context.set_devices_changed_callback"><code class="xref py py-obj docutils literal"><span class="pre">set_devices_changed_callback</span></code></a>(...)</td>
 <td>Register devices changed callback.</td>
@@ -127,7 +127,7 @@ <h1>pyrealsense2.context<a class="headerlink" href="#pyrealsense2-context" title
 <dl class="method">
 <dt id="pyrealsense2.context.query_devices">
 <code class="descname">query_devices</code><span class="sig-paren">(</span><em>self: pyrealsense2.context</em><span class="sig-paren">)</span> &rarr; rs2::device_list<a class="headerlink" href="#pyrealsense2.context.query_devices" title="Permalink to this definition">¶</a></dt>
-<dd><p>Create a static snapshot of all connected devices a the time of the call.</p>
+<dd><p>Create a static snapshot of all connected devices at the time of the call.</p>
 </dd></dl>
 
 <dl class="attribute">

python_docs/_generated/pyrealsense2.depth_frame.html

@@ -49,7 +49,7 @@ <h1>pyrealsense2.depth_frame<a class="headerlink" href="#pyrealsense2-depth-fram
 <dl class="class">
 <dt id="pyrealsense2.depth_frame">
 <em class="property">class </em><code class="descclassname">pyrealsense2.</code><code class="descname">depth_frame</code><a class="headerlink" href="#pyrealsense2.depth_frame" title="Permalink to this definition">¶</a></dt>
-<dd><p>Extend video_frame class with additional depth related attributes and functions.</p>
+<dd><p>Extends the video_frame class with additional depth related attributes and functions.</p>
 <dl class="method">
 <dt id="pyrealsense2.depth_frame.__init__">
 <code class="descname">__init__</code><span class="sig-paren">(</span><em>self: pyrealsense2.depth_frame</em>, <em>arg0: pyrealsense2.frame</em><span class="sig-paren">)</span> &rarr; None<a class="headerlink" href="#pyrealsense2.depth_frame.__init__" title="Permalink to this definition">¶</a></dt>
@@ -96,7 +96,7 @@ <h1>pyrealsense2.depth_frame<a class="headerlink" href="#pyrealsense2-depth-fram
 <td>Retrieve data from the frame handle.</td>
 </tr>
 <tr class="row-even"><td><a class="reference internal" href="#pyrealsense2.depth_frame.get_distance" title="pyrealsense2.depth_frame.get_distance"><code class="xref py py-obj docutils literal"><span class="pre">get_distance</span></code></a>(...)</td>
-<td>Provide the depth in metric units at the given pixel</td>
+<td>Provide the depth in meters at the given pixel</td>
 </tr>
 <tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">get_frame_metadata</span></code>(...)</td>
 <td>Retrieve the current value of a single frame_metadata.</td>
@@ -196,7 +196,7 @@ <h1>pyrealsense2.depth_frame<a class="headerlink" href="#pyrealsense2-depth-fram
 <dl class="method">
 <dt id="pyrealsense2.depth_frame.get_distance">
 <code class="descname">get_distance</code><span class="sig-paren">(</span><em>self: pyrealsense2.depth_frame</em>, <em>x: int</em>, <em>y: int</em><span class="sig-paren">)</span> &rarr; float<a class="headerlink" href="#pyrealsense2.depth_frame.get_distance" title="Permalink to this definition">¶</a></dt>
-<dd><p>Provide the depth in metric units at the given pixel</p>
+<dd><p>Provide the depth in meters at the given pixel</p>
 </dd></dl>
 
 </dd></dl>