absfuyu.core.docstring module

Absfuyu: Core

Sphinx docstring decorator

Version: 5.1.0 Date updated: 10/03/2025 (dd/mm/yyyy)

class absfuyu.core.docstring.SphinxDocstring(version: str, reason: str | None = None, mode: SphinxDocstringMode = SphinxDocstringMode.ADDED)[source]

Bases: object

A class-based decorator to add a ‘Version added’, ‘Version changed’, or ‘Deprecated’ note to a function’s docstring, formatted for Sphinx documentation.

class absfuyu.core.docstring.SphinxDocstringMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: Enum

Enum representing the mode of the version change (added, changed, or deprecated)

ADDED = 'Added'

CHANGED = 'Changed'

DEPRECATED = 'Deprecated'