From 1a735c8612722b0a121b5c780fdde5101f879258 Mon Sep 17 00:00:00 2001 From: Splines Date: Fri, 15 Mar 2024 15:38:33 +0100 Subject: [PATCH] Rename to `to_latex_str` & add docstrings --- src/api/printable_result.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/src/api/printable_result.py b/src/api/printable_result.py index e03f5c49..8debcd17 100644 --- a/src/api/printable_result.py +++ b/src/api/printable_result.py @@ -12,7 +12,12 @@ def print(self): """Prints the result to the console.""" print(Stringifier.result_to_str(self._result)) - def get_latex_str(self) -> str: - """Returns LaTeX string.""" + def to_latex_str(self) -> str: + """Converts the result to a string that can be used in LaTeX documents. + + Note that you might also want to use the `export` method to export + all your results to a file, which can then be included in your LaTeX + document. + """ latexer = _LaTeXer(c.configuration.to_latex_config()) return latexer.result_to_latex_str(self._result)