From 6a33ba58707b42c57e9d04cf84d0e1aae0ec3edf Mon Sep 17 00:00:00 2001 From: Saeed Rasooli Date: Tue, 31 Dec 2024 04:26:15 +0330 Subject: [PATCH] glossary_v2.py: fix / update docstrings --- pyglossary/glossary_v2.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/pyglossary/glossary_v2.py b/pyglossary/glossary_v2.py index 53b0ead5c..e481daba8 100644 --- a/pyglossary/glossary_v2.py +++ b/pyglossary/glossary_v2.py @@ -843,13 +843,14 @@ def write( **kwargs, # noqa: ANN003 ) -> str: """ - Write to a given glossary file, with given format (optional). - Return absolute path of output file, or None if failed. + Write to a given glossary file, with given formatName (optional). + Return absolute path of output file. + Raises Error exception if failed. Parameters ---------- filename (str): file name or path to write. - format (str): format name + formatName (str): format name sort (bool): True (enable sorting), False (disable sorting), @@ -1185,7 +1186,8 @@ def _convertPrepare( def convertV2(self, args: ConvertArgs) -> str: """ - Return absolute path of output file, or None if failed. + Return absolute path of output file. + Raises Error exception if failed. sortKeyName: name of sort key/algorithm