Update docs and changelog to 9.2.2

tango-controls · Sep 27, 2017 · 8f1718f · 8f1718f
1 parent 6f6e419
commit 8f1718f
Show file tree

Hide file tree

Showing 7 changed files with 154 additions and 102 deletions.
diff --git a/doc/howto.rst b/doc/howto.rst
@@ -44,9 +44,9 @@ The PyTango version::
 
     >>> import tango
     >>> tango.__version__
-    '9.2.1'
+    '9.2.2'
     >>> tango.__version_info__
-    (9, 2, 1)
+    (9, 2, 2)
 
 and the Tango C++ library version that PyTango was compiled with::
 

diff --git a/doc/revision.rst b/doc/revision.rst
diff --git a/doc/start.rst b/doc/start.rst
@@ -115,6 +115,6 @@ To test the installation, import ``tango`` and check ``tango.Release.version``:
 .. sourcecode:: console
 
     $ python -c "import tango; print(tango.Release.version)"
-    9.2.1
+    9.2.2
 
 Next steps: Check out the :ref:`pytango-quick-tour`.
diff --git a/doc/utilities.rst b/doc/utilities.rst
@@ -5,7 +5,7 @@ The Utilities API
 
 .. currentmodule:: tango.utils
 
-.. autoclass:: tango.utils.EventCallBack
+.. autoclass:: tango.utils.EventCallback
     :members:
     :undoc-members:
 
@@ -22,7 +22,7 @@ The Utilities API
 .. autofunction:: tango.utils.is_bool
 
 .. autofunction:: tango.utils.is_scalar_type
-    
+
 .. autofunction:: tango.utils.is_array_type
 
 .. autofunction:: tango.utils.is_numerical_type
@@ -33,7 +33,7 @@ The Utilities API
 
 .. autofunction:: tango.utils.is_bool_type
 
-.. autofunction:: tango.utils.is_bin_type
+.. autofunction:: tango.utils.is_binary_type
 
 .. autofunction:: tango.utils.is_str_type
 

diff --git a/tango/device_proxy.py b/tango/device_proxy.py
@@ -1053,7 +1053,7 @@ def __DeviceProxy__get_event_map(self):
 
 def __DeviceProxy__subscribe_event(self, *args, **kwargs):
     """
-        subscribe_event(event_type, cb, stateless=False, green_mode=None) -> int
+    subscribe_event(event_type, cb, stateless=False, green_mode=None) -> int
 
             The client call to subscribe for event reception in the push model.
             The client implements a callback method which is triggered when the
@@ -1073,15 +1073,16 @@ def __DeviceProxy__subscribe_event(self, *args, **kwargs):
                           seconds to subscribe for the specified event. At every
                           subscription retry, a callback is executed which contains
                           the corresponding exception
-            - green_mode :
+            - green_mode : the corresponding green mode (default is GreenMode.Synchronous)
 
         Return     : An event id which has to be specified when unsubscribing
                      from this event.
 
         Throws     : EventSystemFailed
 
 
-        subscribe_event(self, attr_name, event, callback, filters=[], stateless=False, extract_as=Numpy, green_mode=None) -> int
+    subscribe_event(self, attr_name, event, callback, filters=[], stateless=False, extract_as=Numpy, green_mode=None) -> int
+
             The client call to subscribe for event reception in the push model.
             The client implements a callback method which is triggered when the
             event is received. Filtering is done based on the reason specified and
@@ -1090,6 +1091,7 @@ def __DeviceProxy__subscribe_event(self, *args, **kwargs):
             changes. Events consist of an attribute name and the event reason.
             A standard set of reasons are implemented by the system, additional
             device specific reasons can be implemented by device servers programmers.
+
         Parameters :
             - attr_name : (str) The device attribute name which will be sent
                           as an event e.g. "current".
@@ -1113,17 +1115,23 @@ def __DeviceProxy__subscribe_event(self, *args, **kwargs):
                           subscription retry, a callback is executed which contains
                           the corresponding exception
             - extract_as : (ExtractAs)
-            - green_mode :
+            - green_mode : the corresponding green mode (default is GreenMode.Synchronous)
+
         Return     : An event id which has to be specified when unsubscribing
                      from this event.
+
         Throws     : EventSystemFailed
 
-        subscribe_event(self, attr_name, event, queuesize, filters=[], stateless=False, green_mode=None) -> int
+
+    subscribe_event(self, attr_name, event, queuesize, filters=[], stateless=False, green_mode=None) -> int
+
             The client call to subscribe for event reception in the pull model.
             Instead of a callback method the client has to specify the size of the
             event reception buffer.
+
             The event reception buffer is implemented as a round robin buffer. This
             way the client can set-up different ways to receive events:
+
                 * Event reception buffer size = 1 : The client is interested only
                   in the value of the last event received. All other events that
                   have been received since the last reading are discarded.
@@ -1133,6 +1141,7 @@ def __DeviceProxy__subscribe_event(self, *args, **kwargs):
                 * Event reception buffer size = ALL_EVENTS : The client buffers all
                   received events. The buffer size is unlimited and only restricted
                   by the available memory for the client.
+
             All other parameters are similar to the descriptions given in the
             other subscribe_event() version.
     """

diff --git a/tango/device_server.py b/tango/device_server.py
@@ -318,7 +318,8 @@ def __DeviceImpl__add_attribute(self, attr, r_meth=None, w_meth=None, is_allo_me
 
         Return     : (Attr) the newly created attribute.
 
-        Throws     : DevFailed"""
+        Throws     : DevFailed
+    """
 
     attr_data = None
     if isinstance(attr, AttrData):
@@ -363,8 +364,7 @@ def __DeviceImpl__add_attribute(self, attr, r_meth=None, w_meth=None, is_allo_me
 
 
 def __DeviceImpl__remove_attribute(self, attr_name):
-    """
-        remove_attribute(self, attr_name) -> None
+    """remove_attribute(self, attr_name) -> None
 
             Remove one attribute from the device attribute list.
 
@@ -373,7 +373,8 @@ def __DeviceImpl__remove_attribute(self, attr_name):
 
         Return     : None
 
-        Throws     : DevFailed"""
+        Throws     : DevFailed
+    """
     try:
         # Call this method in a try/except in case remove_attribute
         # is called during the DS shutdown sequence
@@ -416,16 +417,17 @@ def __DeviceImpl___remove_attr_meth(self, attr_name):
 
 
 def __DeviceImpl__add_command(self, cmd, device_level=True):
-    """
-        add_command(self, cmd, level=TANGO::OPERATOR) -> cmd
+    """add_command(self, cmd, level=TANGO::OPERATOR) -> cmd
 
         Add a new command to the device command list.
 
         Parameters :
             - cmd          : the new command to be added to the list
             - device_level : Set this flag to true if the command must be added
                              for only this device
+
         Return     : Command
+
         Throws     : DevFailed
     """
     add_name_in_list = False      # This flag is always False, what use is it?
@@ -449,7 +451,7 @@ def __DeviceImpl__add_command(self, cmd, device_level=True):
 
 def __DeviceImpl__remove_command(self, cmd_name, free_it=False, clean_db=True):
     """
-        remove_command(self, attr_name) -> None
+    remove_command(self, attr_name) -> None
 
             Remove one command from the device command list.
 
@@ -458,7 +460,7 @@ def __DeviceImpl__remove_command(self, cmd_name, free_it=False, clean_db=True):
             - free_it  : Boolean set to true if the command object must be freed.
             - clean_db : Clean command related information (included polling info
                          if the command is polled) from database.
-         Return     : None
+        Return     : None
 
         Throws     : DevFailed
     """

diff --git a/tango/server.py b/tango/server.py
@@ -725,7 +725,7 @@ def voltage(self):
     green_mode             :obj:`~tango.GreenMode`          None                                    green mode for read and write. None means use server green mode.
     read_green_mode        :obj:`~tango.GreenMode`          None                                    green mode for read. None means use server green mode.
     write_green_mode       :obj:`~tango.GreenMode`          None                                    green mode for write. None means use server green mode.
-    forwarded              :obj:'bool'                      False                                   the attribute should be forwarded if True
+    forwarded              :obj:`bool`                      False                                   the attribute should be forwarded if True
     ===================== ================================ ======================================= =======================================================================================
 
     .. note::