Skip to content

Commit

Permalink
glossary_v2.py: fix / update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
ilius committed Dec 31, 2024
1 parent cb8a683 commit 6a33ba5
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions pyglossary/glossary_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 6a33ba5

Please sign in to comment.