繁体   English   中英

如何记录方法的 *args 参数? [Python]

[英]How to document *args parameter for method? [Python]

当它包含 * args参数时,如何使用 NumPy (PEP 257) 约定记录方法 arguments?

比如我的class中有这样一个方法:

def add_seis(self, *args, timeout=-1):
    '''
    Add new Seis to live feed
    
    The user can provide an already defined Seis object
    or simply symbol, exchange and interval values. If
    latter is provided then new Seis object will be 
    created and returned after adding it to the live feed.
    Timeout value can be used to specify maximum wait time
    for the method to return.
    
    Parameters
    ----------
    ???
    '''

go 在参数部分应该是什么? 如果我的意图是确保能够提供单个 object(Seis)或三个对象(str、str、Interval),那么记录此内容的正确方法是什么,然后在内部创建相同的 object?

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM