sphinx/tests/roots/test-ext-autodoc/target/private.py

def private_function(name):
    """private_function is a docstring().

    :meta private:
    """

def _public_function(name):
    """public_function is a docstring().

    :meta public:
    """
Close #6830: autodoc: consider a member private if docstring has "private" metadata 2019-12-31 23:40:13 -06:00			`def private_function(name):`
			`"""private_function is a docstring().`

			`:meta private:`
			`"""`
Add support for :meta public: A common use case for this is a class like `namedtuple`, which has a public `_replace` method that is so-named in order not to conflict with arbitrary user-provided attributes. Rejected spellings include: * `:meta not-private:` * `:meta private: False` 2020-04-13 09:55:07 -05:00
			`def _public_function(name):`
			`"""public_function is a docstring().`

			`:meta public:`
			`"""`