NumPy для типа строка документации функции и None типа

Question

я пишу следующую функцию:

def parse_zip_file(path, handler): 
    """ 
    Parse all files contained in a zip file (specified by the path parameter). 

    Parameters 
    ---------- 
    path : str 
     The path to the zip file. 
    handler: function 
     When looping through all the files contained in the zip file, this method will be called every time 
     a new file is found. Two arguments are passed. The first argument is the name of the discovered file 
     and the second argument are the contents of the file. 

    Returns 
    ------- 
    None 
     Nothing is returned. 
    """ 
    return None 

Мне было интересно, я правильно делаю это? Есть ли способ проверить правильность docstring (я использую PyCharm в качестве редактора)? Точнее, это function правильный тип аргумента обработчика? Где я могу найти обзор всех типов docstring NumPy, которые я могу использовать? И правильно ли, что я использую None, если ничего не возвращается вообще?

Answer 1

строки документации будут автоматически генерироваться в PyCharm с помощью """ """ и нажмите клавишу Enter после объявления функции для использования типа возвращаемого :rtype: None