From e568c665a8f73881e6191276e64ce9199f83425e Mon Sep 17 00:00:00 2001
From: l_samenv <l_samenv@samenv.psi.ch>
Date: Tue, 2 Mar 2021 13:42:10 +0100
Subject: [PATCH] improve tutorial_helevel

- fix indent of query method
- add remark about the CCU4 cid command

Change-Id: Iaee821cf7739536cc823494f646a1d2a4bbbfa44
Reviewed-on: https://forge.frm2.tum.de/review/c/sine2020/secop/playground/+/25092
Tested-by: Jenkins Automated Tests <pedersen+jenkins@frm2.tum.de>
Reviewed-by: Markus Zolliker <markus.zolliker@psi.ch>
---
 doc/source/tutorial_helevel.rst | 21 +++++++++++----------
 1 file changed, 11 insertions(+), 10 deletions(-)

diff --git a/doc/source/tutorial_helevel.rst b/doc/source/tutorial_helevel.rst
index d778c2d..f073cf8 100644
--- a/doc/source/tutorial_helevel.rst
+++ b/doc/source/tutorial_helevel.rst
@@ -30,6 +30,7 @@ CCU4 luckily has a very simple and logical protocol:
         # for completeness: (not needed, as it is the default)
         end_of_line = '\n'
         # on connect, we send 'cid' and expect a reply starting with 'CCU4'
+        # 'cid' is a CCU4 command returning the current version prefixed with CCU4
         identification = [('cid', r'CCU4.*')]
 
 
@@ -144,16 +145,16 @@ which means it might be worth to create a *query* method, and then the
         ...
 
 
-    def query(self, cmd):
-        """send a query and get the response
+        def query(self, cmd):
+            """send a query and get the response
 
-        :param cmd: the name of the parameter to query or '<parameter>=<value'
-                    for changing a parameter
-        :returns: the (new) value of the parameter
-        """
-        name, txtvalue = self._iodev.communicate(cmd).split('=')
-        assert name == cmd.split('=')[0]  # check that we got a reply to our command
-        return txtvalue  # Frappy will automatically convert the string to the needed data type
+            :param cmd: the name of the parameter to query or '<parameter>=<value'
+                        for changing a parameter
+            :returns: the (new) value of the parameter
+            """
+            name, txtvalue = self._iodev.communicate(cmd).split('=')
+            assert name == cmd.split('=')[0]  # check that we got a reply to our command
+            return txtvalue  # Frappy will automatically convert the string to the needed data type
 
         def read_value(self):
             return self.query('h')
@@ -247,4 +248,4 @@ the parameters *empty_length* and *full_length* from the client by defining:
 
 However, we do not put this here, as it is nice to try out changing parameters for a test!
 
-*to be continued*
\ No newline at end of file
+*to be continued*