What are the most common Python docstring formats?
Become part of the top 3% of the developers by applying to Toptal https://topt.al/25cXVn
--
Music by Eric Matyas
https://www.soundimage.org
Track title: Ocean Floor
--
Chapters
00:00 Question
00:21 Accepted answer (Score 1390)
03:17 Answer 2 (Score 354)
04:00 Answer 3 (Score 244)
05:29 Answer 4 (Score 67)
06:32 Thank you
--
Full question
https://stackoverflow.com/questions/3898572/what-are-the-most-common-python-docstring-formats
Accepted answer links:
[this blog post]: http://daouzli.com/blog/docstring.html
[PEP 287]: https://www.python.org/dev/peps/pep-0287
[Epydoc]: http://epydoc.sourceforge.net
[Sphinx]: http://sphinx-doc.org
[format]: https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings
[Napoleon plugin]: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/
[more examples]: https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html#example-google
[numpydoc]: https://numpydoc.readthedocs.io/en/latest/
[Pyment]: https://github.com/dadadel/pyment
[Pyment documentation]: https://github.com/dadadel/pyment/blob/master/README.rst
Answer 2 links:
[Google style guide]: https://github.com/google/styleguide
[conventions for readable docstring syntax]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
[Sphinx documentation tutorial]: https://pythonhosted.org/an_example_pypi_project/sphinx.html#full-code-example
Answer 3 links:
[PEP-257]: http://www.python.org/dev/peps/pep-0257/
Answer 4 links:
[specification of the format]: https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard
[example]: https://github.com/numpy/numpy/blob/master/doc/example.py
[numpydoc]: https://github.com/numpy/numpydoc
http://docs.scipy.org/doc/numpy/reference/generated/numpy.mean.html
[comparison]: http://sphinxcontrib-napoleon.readthedocs.org/en/latest/#google-vs-numpy
--
Content licensed under CC BY-SA
https://meta.stackexchange.com/help/licensing
--
Tags
#python #codingstyle #documentation #docstring
#avk47
Что делает видео по-настоящему запоминающимся? Наверное, та самая атмосфера, которая заставляет забыть о времени. Когда вы заходите на RUVIDEO, чтобы посмотреть онлайн «What are the most common Python docstring formats?», вы рассчитываете на нечто большее, чем просто загрузку плеера. И мы это понимаем. Контент такого уровня заслуживает того, чтобы его смотрели в HD 1080, без дрожания картинки и бесконечного буферизации.
Честно говоря, Rutube сегодня — это кладезь уникальных находок, которые часто теряются в общем шуме. Мы же вытаскиваем на поверхность самое интересное. Будь то динамичный экшн, глубокий разбор темы от любимого автора или просто уютное видео для настроения — всё это доступно здесь бесплатно и без лишних формальностей. Никаких «заполните анкету, чтобы продолжить». Только вы, ваш экран и качественный поток.
Если вас зацепило это видео, не забудьте взглянуть на похожие материалы в блоке справа. Мы откалибровали наши алгоритмы так, чтобы они подбирали контент не просто «по тегам», а по настроению и смыслу. Ведь в конечном итоге, онлайн-кинотеатр — это не склад файлов, а место, где каждый вечер можно найти свою историю. Приятного вам отдыха на RUVIDEO!
Видео взято из открытых источников Rutube. Если вы правообладатель, обратитесь к первоисточнику.