Archived

This forum has been archived. Please start a new discussion on GitHub.

python docstrings for methods with out parameter

rnestler
rnestler
in Help Center
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:

Example:
module a {
          interface foo{
                  /**
                   * execute bar
                   * @param aFooBar The calculated foo-bar
                   */
                  void bar(out int aFooBar);
          };
  };

def bar(self, current=None):
              '''execute bar
  Arguments:
      aFooBar  The calculated foo-bar'''
              pass

Also the docstrings should use double quotes ( https://www.python.org/dev/peps/pep-0257/ )

Categories