missing docstrings added

This commit is contained in:
Nicolas 2025-04-13 17:33:21 +02:00
parent e29115e28b
commit 12c18dd2d8
1 changed files with 30 additions and 1 deletions

View File

@ -284,6 +284,9 @@ class DocumentWriter():
A class to create a document for exporting to HTML or LaTeX. A class to create a document for exporting to HTML or LaTeX.
""" """
def __init__(self) -> None: def __init__(self) -> None:
"""
Initializes the DocumentWriter instance.
"""
self._doc: list[list[Callable[[], str]]] = [] self._doc: list[list[Callable[[], str]]] = []
self._fields: dict[str, DocumentWriter] = dict() self._fields: dict[str, DocumentWriter] = dict()
self._base64_svgs: bool = False self._base64_svgs: bool = False
@ -313,6 +316,19 @@ class DocumentWriter():
def add_diagram(self, fig: Figure, caption: str = '', ref_id: str = '', def add_diagram(self, fig: Figure, caption: str = '', ref_id: str = '',
prefix_pattern: str = 'Figure {}: ', ref_type: str = 'fig', prefix_pattern: str = 'Figure {}: ', ref_type: str = 'fig',
centered: bool = True) -> None: centered: bool = True) -> None:
"""
Adds a diagram to the document.
Args:
fig: The figure to add (matplotlib figure)
caption: The caption for the figure
ref_id: If provided, the figure can be referenced by this string
prefix_pattern: A custom string for the caption prefix, {} will
be replaced by the figure number
ref_type: The type of reference. Each type (e.g., 'fig', 'table')
has an individual numbering
centered: Whether to center the figure in LaTeX output
"""
caption_prefix = self._add_item(ref_id, ref_type, prefix_pattern) caption_prefix = self._add_item(ref_id, ref_type, prefix_pattern)
def render_to_html() -> str: def render_to_html() -> str:
@ -331,6 +347,19 @@ class DocumentWriter():
def add_table(self, table: Table, caption: str = '', ref_id: str = '', def add_table(self, table: Table, caption: str = '', ref_id: str = '',
prefix_pattern: str = 'Table {}: ', ref_type: str = 'table', centered: bool = True) -> None: prefix_pattern: str = 'Table {}: ', ref_type: str = 'table', centered: bool = True) -> None:
"""
Adds a table to the document.
Args:
table: The table to add (pandas DataFrame or Styler)
caption: The caption for the table
ref_id: If provided, the table can be referenced by this string
prefix_pattern: A custom string for the caption prefix, {} will
be replaced by the table number
ref_type: The type of reference. Each type (e.g., 'fig', 'table')
has an individual numbering
centered: Whether to center the table in LaTeX output
"""
assert Table and isinstance(table, Table), 'Table has to be a pandas DataFrame oder DataFrame Styler' assert Table and isinstance(table, Table), 'Table has to be a pandas DataFrame oder DataFrame Styler'
caption_prefix = self._add_item(ref_id, ref_type, prefix_pattern) caption_prefix = self._add_item(ref_id, ref_type, prefix_pattern)
styler = table if isinstance(table, Styler) else getattr(table, 'style', None) styler = table if isinstance(table, Styler) else getattr(table, 'style', None)
@ -545,7 +574,7 @@ class DocumentWriter():
If no path is provided a default template is used. If no path is provided a default template is used.
Returns: Returns:
True if the PDF was successfully created True if the PDF file was successfully created
""" """
latex_code = inject_to_template(self.to_latex(font_family, table_renderer), latex_code = inject_to_template(self.to_latex(font_family, table_renderer),
latex_template_path, latex_template_path,