In Python Docstrings, What Does `: obj:` do?

I continue to see docstrings that have lines that read like this:

param : :obj: str

I cannot find a link to what it means :obj:or does. I think he will designate an object str, but I also see

param : int

which does not seem to be a jib.

Thank.

+4
source share
2 answers

This is not Python built-in functionality. The author of the code you are looking for uses an external tool to automatically generate documentation. It looks like Sphinx syntax, but I'm not sure.

, . , /.

+3
+2

Source: https://habr.com/ru/post/1663651/


All Articles