python – how does one include a variable in the doc string?

python – how does one include a variable in the doc string?

Changing the docstring afterwards (by assigning to do_this.__doc__) is the only way.

Or if you want it to look nicer, you can use a decorator – but it still assigns to do_this.__doc__.

def doc(docstring):
    def document(func):
        func.__doc__ = docstring
        return func

    return document

@doc(this command accepts these values: {values}.format(values=[1, 2, 3])
def do_this(self, arg):
    pass

As you have this values in variable, you can reference to it in doc:

# mymodule.py
legal_values = {one, two, three}

def do_this(self,arg)
    this command accepts these values: see `mymodule.legal_values`

python – how does one include a variable in the doc string?

Leave a Reply

Your email address will not be published. Required fields are marked *