fix comments ngraph api 2021.2 (openvinotoolkit#3520)

* fix comments ngraph api * remove whitespace * fixes Co-authored-by: Nikolay Tyukaev <[email protected]>
maxim-kurin · Jan 20, 2021 · 42a5fff · 42a5fff
1 parent 0c7428e
commit 42a5fff
Show file tree

Hide file tree

Showing 18 changed files with 300 additions and 309 deletions.
diff --git a/docs/doxygen/ngraph_py_api.xml b/docs/doxygen/ngraph_py_api.xml
@@ -19,10 +19,7 @@
       <tab type="user" title="DL Streamer API Reference" url="https://openvinotoolkit.github.io/dlstreamer_gst/"/>
       <tab type="user" title="nGraph С++ API Reference" url="../ngraph_cpp_api/annotated.html"/>
       <!-- nGraph Python API Reference -->
-      <tab type="files" visible="yes" title="nGraph Python API Reference">
-        <tab type="filelist" visible="yes" title="nGraph Python API Reference" intro=""/>
-        <tab type="globals" visible="yes" title="" intro=""/>
-      </tab>
+      <tab type="filelist" visible="yes" title="nGraph Python API Reference" intro=""/>
     </tab>
     <!-- Chinese docs -->
     <tab type="user" title="中文文件" url="https://docs.openvinotoolkit.org/cn/index.html"/>

diff --git a/ngraph/python/src/ngraph/__init__.py b/ngraph/python/src/ngraph/__init__.py
@@ -13,7 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ******************************************************************************
-"""! ngraph module namespace, exposing factory functions for all ops and other classes."""
+"""ngraph module namespace, exposing factory functions for all ops and other classes."""
 # noqa: F401
 
 from pkg_resources import get_distribution, DistributionNotFound

diff --git a/ngraph/python/src/ngraph/exceptions.py b/ngraph/python/src/ngraph/exceptions.py
@@ -13,16 +13,16 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ******************************************************************************
-"""! ngraph exceptions hierarchy. All exceptions are descendants of NgraphError."""
+"""ngraph exceptions hierarchy. All exceptions are descendants of NgraphError."""
 
 
 class NgraphError(Exception):
-    """! Base class for Ngraph exceptions."""
+    """Base class for Ngraph exceptions."""
 
 
 class UserInputError(NgraphError):
-    """! User provided unexpected input."""
+    """User provided unexpected input."""
 
 
 class NgraphTypeError(NgraphError, TypeError):
-    """! Type mismatch error."""
+    """Type mismatch error."""
diff --git a/ngraph/python/src/ngraph/helpers.py b/ngraph/python/src/ngraph/helpers.py
@@ -13,14 +13,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ******************************************************************************
-"""! nGraph helper functions."""
+"""nGraph helper functions."""
 
 from ngraph.impl import Function
 from openvino.inference_engine import IENetwork
 
 
 def function_from_cnn(cnn_network: IENetwork) -> Function:
-    """! Get nGraph function from Inference Engine CNN network."""
+    """Get nGraph function from Inference Engine CNN network."""
     capsule = cnn_network._get_function_capsule()
     ng_function = Function.from_capsule(capsule)
     return ng_function

diff --git a/ngraph/python/src/ngraph/impl/op/__init__.py b/ngraph/python/src/ngraph/impl/op/__init__.py
@@ -24,7 +24,7 @@
 
 from _pyngraph.op import Constant
 
-""" Retrieve Constant inner data.
+"""Retrieve Constant inner data.
 
     Internally uses PyBind11 Numpy's buffer protocol.