文档字符串信息以引用序列时间段

Question

我正在编写代码中的功能文档，我想征求一些说明的建议，以确保任何人都可以轻松理解它。

我正在使用pycharm和reStructuredText作为文档字符串格式。

函数上最常见的变量是

 - from_date
 - to_date

函数示例：

def db_info(from_date: datetime, to_date: datetime):
    """ Retreive the database information for a period of time

    :param start_date:  When to begin the search
    :type start_date:   datetime
    :param end_date:    When to finish the search
    :type end_date:     datetime
    :return:            database information for a period of time
    :rtype:             DataFrame

    # lines of code to retreive the data

1。是否有参考一段时间的最佳做法？

我还没有找到有关哪种方法最好记录这一点的信息

2。您认为这足够理解吗？