Come documentare i kwarg in stile Sfinge?

0

Mi chiedo come posso documentare **kwargs in Python usando lo stile di sforzare lo sfarfallio.

Ad esempio, ho il seguente metodo e voglio documentare maggiori dettagli su kwargs.

  def get(self, url=None, **kwargs):
    """
    InsReq get (overriding)
    :param url: url
    :type url: str
    :param kwargs: How to document these most used parameters?
    :type kwargs: dict
    :return: response object
    :rtype: requests.models.Response
    """
    [...]

utilizzo del metodo:

>>> obj.get(url='http://google.com', delay=10, retries=5)

Hai qualche idea che sia il modo "corretto" per documentare questi parametri extra?

    
posta Simakis Panagiotis 12.04.2018 - 13:23
fonte

1 risposta

2

Puoi utilizzare valori letterali incorporati come:

'**kwargs'

o blocchi in linea come

::
    **kwargs

Per ulteriori informazioni guarda here

    
risposta data 04.12.2018 - 01:02
fonte

Leggi altre domande sui tag