mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
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`
12 lines
195 B
Python
12 lines
195 B
Python
def private_function(name):
|
|
"""private_function is a docstring().
|
|
|
|
:meta private:
|
|
"""
|
|
|
|
def _public_function(name):
|
|
"""public_function is a docstring().
|
|
|
|
:meta public:
|
|
"""
|