Прежде чем приступить к изучению и тестированию библиотеки moexalgo, которая упрощает работу с AlgoPack API, я решил для удобства её изучения создать документацию (help).
Это очень важно и удобно, особенно для таких как я – начинающих изучать язык Python.
Зачем нужно документировать библиотеки Python?
Хорошо документированная библиотека сильно повышает ее ценность для сообщества разработчиков и упрощает её использование.
Документирование библиотеки облегчает использование и понимание – можно сразу узнать для чего предназначен каждый объект и метод библиотеки;
Наличие документации определенно увеличит вовлеченность со стороны сообщества, а также сокращает время на разработку, поддержку и любые изменения кода.
Docstrings (докстринги) – это строки документации в исходном коде на Python, которые описывают, что делает код. Они пишутся в самом начале определения функций, методов, классов или модулей и заключаются в тройные кавычки. Примерно так:
def summa_ab(a,b):
"""Суммируются переданные числа"""
result = a + b
return resultКонечно рекомендуется еще и добавлять рабочие примеры использования, дополнять описания реальными примерами работы с кодом. Это избавляет пользователей от необходимости самостоятельно экспериментировать.
Для текущей версии библиотеки moexalgo 1.0.1 я сгенерировал документацию в виде HTML страниц. Сделано это одной командой с помощью утилиты pdoc.
Получилась полноценная справка, пользуйтесь.
Онлайн документация по библиотеке moexalgo.
Сделать такую же Вы можете и самостоятельно с помощью команды pdoc --html -o ./ moexalgo
