информация документации для обозначения периодов последовательности - PullRequest
Новая
       28

информация документации для обозначения периодов последовательности

0 голосов
/ 16 ноября 2018

Я нахожусь в процессе документирования функций в коде, и я хотел бы попросить совета по некоторым описаниям, чтобы любой мог легко понять это.

Я использую 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. Вы находите это достаточно понятным?

...