Updated 0.8.5 documentation

docs/about_ydk.html

@@ -157,7 +157,7 @@ <h2>Version<a class="headerlink" href="#version" title="Permalink to this headli
 <p>To check out the version of ydk-gen used to generate this ydk-py, use the below commands:</p>
 <div class="highlight-bash"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1
 2</pre></div></td><td class="code"><div class="highlight"><pre><span></span>$ git clone https://github.com/ygorelik/ydk-gen.git
-$ git checkout 2d0c87cf265dc832934ece2ae84fcd8c86251b4c
+$ git checkout ad71284fb6066930880be69ae9d163b2a0194699
 </pre></div>
 </td></tr></table></div>
 </div>

docs/api/errors.html

@@ -160,6 +160,20 @@
 <p>Base class for Y Errors. The subclasses give a specialized view of the error that has occurred.</p>
 </dd></dl>
 
+<dl class="exception">
+<dt id="ydk.errors.YCoreError">
+<em class="property">exception </em><code class="descclassname">ydk.errors.</code><code class="descname">YCoreError</code><a class="headerlink" href="#ydk.errors.YCoreError" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#ydk.errors.YError" title="ydk.errors.YError"><code class="xref py py-exc docutils literal"><span class="pre">ydk.errors.YError</span></code></a></p>
+<p>Core Error. Base exception class for all YDK core errors.</p>
+</dd></dl>
+
+<dl class="exception">
+<dt id="ydk.errors.YCodecError">
+<em class="property">exception </em><code class="descclassname">ydk.errors.</code><code class="descname">YCodecError</code><a class="headerlink" href="#ydk.errors.YCodecError" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#ydk.errors.YCoreError" title="ydk.errors.YCoreError"><code class="xref py py-exc docutils literal"><span class="pre">ydk.errors.YCoreError</span></code></a></p>
+<p>Codec Error. Thrown when a Path Codec fails to perform encoding or decoding.</p>
+</dd></dl>
+
 <dl class="exception">
 <dt id="ydk.errors.YModelError">
 <em class="property">exception </em><code class="descclassname">ydk.errors.</code><code class="descname">YModelError</code><a class="headerlink" href="#ydk.errors.YModelError" title="Permalink to this definition">¶</a></dt>
@@ -206,7 +220,7 @@
 <dt id="ydk.errors.YServiceError">
 <em class="property">exception </em><code class="descclassname">ydk.errors.</code><code class="descname">YServiceError</code><a class="headerlink" href="#ydk.errors.YServiceError" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="#ydk.errors.YError" title="ydk.errors.YError"><code class="xref py py-exc docutils literal"><span class="pre">ydk.errors.YError</span></code></a></p>
-<p>Exception for Service Side Validation</p>
+<p>Exception for Service Side Validation.</p>
 </dd></dl>
 
 </div>

docs/api/path/codec.html

@@ -162,40 +162,55 @@
 <dl class="class">
 <dt id="ydk.path.Codec">
 <em class="property">class </em><code class="descclassname">ydk.path.</code><code class="descname">Codec</code><a class="headerlink" href="#ydk.path.Codec" title="Permalink to this definition">¶</a></dt>
-<dd><p>YDK Path Codec used to encode and decode between payload and <code class="docutils literal"><span class="pre">DataNode</span></code>.</p>
+<dd><p>YDK Path Codec provides encode and decode translations between string payload and <a class="reference internal" href="data_node.html#ydk.path.DataNode" title="ydk.path.DataNode"><code class="xref py py-class docutils literal"><span class="pre">DataNode</span></code></a>.</p>
 <dl class="method">
 <dt>
-<code class="descname">encode(data_node, encoding, pretty):</code></dt>
-<dd><p>Encoding data in <code class="docutils literal"><span class="pre">data_node</span></code> to string payload.</p>
+<code class="descname">encode(data_node, encoding, pretty=True):</code></dt>
+<dd><p>Encodes data in <cite>data_node</cite> to string payload.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>data_node</strong> &#8211; (<a class="reference internal" href="data_node.html#ydk.path.DataNode" title="ydk.path.DataNode"><code class="xref py py-class docutils literal"><span class="pre">DataNode</span></code></a>) Path <code class="docutils literal"><span class="pre">DataNode</span></code> to encode.</li>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>data_node</strong> &#8211; <p>(<a class="reference internal" href="data_node.html#ydk.path.DataNode" title="ydk.path.DataNode"><code class="xref py py-class docutils literal"><span class="pre">DataNode</span></code></a>) for single data node to encode.</p>
+<p>For multiple data nodes encapsulate <a class="reference internal" href="data_node.html#ydk.path.DataNode" title="ydk.path.DataNode"><code class="xref py py-class docutils literal"><span class="pre">DataNode</span></code></a> instances into Python <code class="docutils literal"><span class="pre">list</span></code>.</p>
+</li>
 <li><strong>encoding</strong> &#8211; (<a class="reference internal" href="../types.html#ydk.types.EncodingFormat" title="ydk.types.EncodingFormat"><code class="xref py py-class docutils literal"><span class="pre">EncodingFormat</span></code></a>) Encoding format.</li>
 <li><strong>pretty</strong> &#8211; (<code class="docutils literal"><span class="pre">bool</span></code>) Pretty format.</li>
 </ul>
 </td>
 </tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">(<code class="docutils literal"><span class="pre">str</span></code>) encoded payload.</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><code class="docutils literal"><span class="pre">RuntimeError</span></code> with <a class="reference internal" href="../errors.html#ydk.errors.YCodecError" title="ydk.errors.YCodecError"><code class="xref py py-exc docutils literal"><span class="pre">YCodecError</span></code></a> prefix, if an error has occurred.</p>
+</td>
+</tr>
 </tbody>
 </table>
 </dd></dl>
 
 <dl class="method">
 <dt>
 <code class="descname">decode(root_schema_node, payload, encoding):</code></dt>
-<dd><table class="docutils field-list" frame="void" rules="none">
+<dd><p>Decodes payload string into <a class="reference internal" href="data_node.html#ydk.path.DataNode" title="ydk.path.DataNode"><code class="xref py py-class docutils literal"><span class="pre">DataNode</span></code></a> instance.</p>
+<table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>root_schema_node</strong> &#8211; (<a class="reference internal" href="root_schema_node.html#ydk.path.RootSchemaNode" title="ydk.path.RootSchemaNode"><code class="xref py py-class docutils literal"><span class="pre">RootSchemaNode</span></code></a>) A Path <code class="docutils literal"><span class="pre">RootSchemaNode</span></code></li>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>root_schema_node</strong> &#8211; (<a class="reference internal" href="root_schema_node.html#ydk.path.RootSchemaNode" title="ydk.path.RootSchemaNode"><code class="xref py py-class docutils literal"><span class="pre">RootSchemaNode</span></code></a>) An instance of <cite>root_schema_node</cite>.</li>
 <li><strong>payload</strong> &#8211; (<code class="docutils literal"><span class="pre">str</span></code>) Payload to decode.</li>
 <li><strong>encoding</strong> &#8211; (<a class="reference internal" href="../types.html#ydk.types.EncodingFormat" title="ydk.types.EncodingFormat"><code class="xref py py-class docutils literal"><span class="pre">EncodingFormat</span></code></a>) Encoding format.</li>
 </ul>
 </td>
 </tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">(<a class="reference internal" href="data_node.html#ydk.path.DataNode" title="ydk.path.DataNode"><code class="xref py py-class docutils literal"><span class="pre">DataNode</span></code></a>) instance of a <cite>data-node</cite>.</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><code class="docutils literal"><span class="pre">RuntimeError</span></code> with <a class="reference internal" href="../errors.html#ydk.errors.YCodecError" title="ydk.errors.YCodecError"><code class="xref py py-exc docutils literal"><span class="pre">YCodecError</span></code></a> prefix, if an error has occurred.</p>
+</td>
+</tr>
 </tbody>
 </table>
 </dd></dl>