2022-01-14

How to document returning tuples in python for Pycharm with docstring

I have seen this question asked all over the internet, but with no answers that seem to work.

def testing_return_documentation(one, two):
    """
    tests documentation of arguments and returns
    :param one: testing
    :param two: another test

    :return: a thing
    """
    return one

Looks like this in Pycharm when you hover over the function: enter image description here

But how do you document returning a tuple?

def testing_return_documentation(one, two):
    """
    tests documentation of arguments and returns
    :param one: testing
    :param two: another test
    :return: how do you make good things happen here?
    """
    return one, two


from Recent Questions - Stack Overflow https://ift.tt/3rffoLy
https://ift.tt/3I7X3XN

No comments:

Post a Comment