shnitsel.__api_info¶
Attributes¶
Functions¶
|
Decorator to mark a function as for internal use only. |
|
Decorator to mark a function as a part of the public API. |
Module Contents¶
- Param¶
- RetType¶
- internal()¶
Decorator to mark a function as for internal use only.
Stability of the function interface is not guaranteed. May modify the docstring of the function to signify that it is indeed intended for internal use only.
- Returns:
The function with an internal annotation that its use should be internal.
- API()¶
Decorator to mark a function as a part of the public API.
Stability of the function interface will be maintained across minor versions unless stated explicitly May modify the docstring of the function to signify that it is indeed part of the public API
- Returns:
The function with an internal annotation that its use may be public.
- public¶