Home Help Center

python docstrings for methods with out parameter

rnestlerrnestler Member Raphael NestlerOrganization: Sensirion AGProject: Calibration and test system
Hi ZeroC

When generating python bindings with slice2py out parameters get mapped to a returned tuple (see https://zeroc.com/doc/Ice-3.4.1/manual/Python.23.12.html)

However the generated docstrings still document them as parameters:

module a {
          interface foo{
                   * execute bar
                   * @param aFooBar The calculated foo-bar
                  void bar(out int aFooBar);
def bar(self, current=None):
              '''execute bar
      aFooBar  The calculated foo-bar'''

Also the docstrings should use double quotes ( https://www.python.org/dev/peps/pep-0257/ )
Sign In or Register to comment.