[pytango] 390/483: Update documentation

Sandor Bodo-Merle sbodomerle-guest at moszumanska.debian.org
Thu Sep 28 19:15:04 UTC 2017


This is an automated email from the git hooks/post-receive script.

sbodomerle-guest pushed a commit to annotated tag bliss_8.10
in repository pytango.

commit cd868bc252f45becda4b9ad64d5e40224e42cc15
Author: tiagocoutinho <tiagocoutinho at 4e9c00fd-8f2e-0410-aa12-93ce3db5e235>
Date:   Thu May 15 19:02:24 2014 +0000

    Update documentation
    
    git-svn-id: http://svn.code.sf.net/p/tango-cs/code/bindings/PyTango/trunk@25638 4e9c00fd-8f2e-0410-aa12-93ce3db5e235
---
 doc/howto.rst               | 45 ++++++++++++++++++++-------------------------
 src/boost/python/release.py |  2 +-
 2 files changed, 21 insertions(+), 26 deletions(-)

diff --git a/doc/howto.rst b/doc/howto.rst
index 06001b5..c6a4599 100644
--- a/doc/howto.rst
+++ b/doc/howto.rst
@@ -17,9 +17,10 @@ Check the default TANGO host
 ----------------------------
 
 The default TANGO host can be defined using the environment variable 
-:envvar:`TANGO_HOST` or in a `tangorc` file.
+:envvar:`TANGO_HOST` or in a `tangorc` file
 (see `Tango environment variables <http://www.esrf.eu/computing/cs/tango/tango_doc/kernel_doc/ds_prog/node11.html#SECTION0011123000000000000000>`_
 for complete information)
+
 To check what is the current value that TANGO uses for the default configuration
 simple do::
  
@@ -27,19 +28,6 @@ simple do::
     >>> PyTango.ApiUtil.get_env_var("TANGO_HOST")
     'homer.simpson.com:10000'
 
-
-Work with Groups
-----------------
-
-.. todo:: 
-   write this how to
-
-Handle errors
--------------
-
-.. todo:: 
-   write this how to
-
 Check TANGO version
 -------------------
 
@@ -72,6 +60,19 @@ It can be a dump of::
 
    $ python -c "from PyTango.utils import info; print(info())"
 
+
+Work with Groups
+----------------
+
+.. todo:: 
+   write this how to
+
+Handle errors
+-------------
+
+.. todo:: 
+   write this how to
+
 .. _pytango-howto-server:
 
 Write a server
@@ -126,23 +127,18 @@ high level API
     :class:`PyTango.server.DeviceClass`. This has to be done due to a limitation
     on boost-python
 
-**line 10**
+**line 10-12**
     definition of the *time* attribute. By default, attributes are double, scalar, 
     read-only. Check the :class:`~PyTango.server.attribute` for the complete
     list of attribute options.
 
-**line 12-13**
-    the method that is called when a client reads the *time* attribute from this
-    device. By default, Tango expects a method called ``read_<attribute name>``
-    to exist for every attribute
-
-**line 15-17**
+**line 14-16**
     the method *strftime* is exported as a Tango command. In receives a string
     as argument and it returns a string. If a method is to be exported as a
     Tango command, it must be decorated as such with the
     :func:`~PyTango.server.command` decorator
 
-**line 21**
+**line 20**
     start the Tango run loop. The mandatory argument is a list of python classes
     that are to be exported as Tango classes. Check :func:`~PyTango.server.run`
     for the complete list of options
@@ -171,8 +167,6 @@ using the high level API. The example contains:
     class PowerSupply(Device):
         __metaclass__ = DeviceMeta
 
-        voltage = attribute()
-
         current = attribute(label="Current", dtype=float,
                             display_level=DispLevel.EXPERT,
                             access=AttrWriteType.READ_WRITE,
@@ -190,7 +184,8 @@ using the high level API. The example contains:
         host = device_property(dtype=str)
         port = class_property(dtype=int, default_value=9788)
 
-        def read_voltage(self):
+	@attribute
+        def voltage(self):
             self.info_stream("get voltage(%s, %d)" % (self.host, self.port))
             return 10.0
 
diff --git a/src/boost/python/release.py b/src/boost/python/release.py
index c995254..489d1c8 100644
--- a/src/boost/python/release.py
+++ b/src/boost/python/release.py
@@ -40,7 +40,7 @@ class Release:
             - keywords : (seq<str>) list of keywords
             - license : (str) the license"""
     name = 'PyTango'
-    version_info = (8, 1, 2, 'dev', 0)
+    version_info = (8, 1, 2, 'final', 0)
     version = '.'.join(map(str, version_info[:3]))
     version_long = version + ''.join(map(str, version_info[3:]))
     version_description = 'This version implements the C++ Tango 8.1 API.'

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/pytango.git



More information about the debian-science-commits mailing list