Как перечислить * аргументы мультиинтерфейсной функции в строке документации в стиле Google? - PullRequest
Новая
       30

Как перечислить * аргументы мультиинтерфейсной функции в строке документации в стиле Google?

1 голос
/ 03 августа 2020

У меня есть следующая функция, и мне интересно, как правильно документировать ее многочисленные интерфейсы: 

def log(self, *args):
    """Logs data in-memory to a list container, associated with a unix-path-like key.

    Args:
        **either**
        vpath (str): Virtual path
        value (Any): Value to store
        **or**
        vpath_value_map (Dict[str, Any]): Mapping of vpaths and values to store

    Raises:
        TypeError -- Wrong number of arguments.
    """
    if not (0 < len(args) < 3):
        raise TypeError("Method has to be called with either one or two arguments.")

Я хотел бы придерживаться стиля Google, и в идеале Sphinx должен работать с ним. Спасибо за помощь.

...