Skip to content

Commit

Permalink
docstring updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Attolight-NTappy committed Jul 4, 2024
1 parent da78b28 commit 67229b3
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions rsciio/digitalsurf/_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,18 +68,18 @@ def parse_metadata(cmt : str, prefix : str = '$', delimiter : str = '=') -> dict
----------
cmt : str
Str containing contents of a digitalsurf file "comment" field.
prefix : str, default = '$'
Prefix character, must be present at the start of each line.
Otherwise, the line is ignored. '$' for digitalsurf files,
typically '' when parsing from text files.
delimiter : string, default = '='
prefix : str
Prefix character, must be present at the start of each line,
otherwise the line is ignored. ``"$"`` for digitalsurf files,
typically an empty string (``""``) when parsing from text files.
Default is ``"$"``.
delimiter : str
Character that delimit key-value pairs in digitalsurf comment.
Usually, '=' is used.
Default is ``"="``.
Returns
-------
dict_md : dict
Nested dictionnary containing comment contents.
dict
Nested dictionnary of the metadata.
"""
# dict_ms is created as an empty dictionnary
Expand Down

0 comments on commit 67229b3

Please sign in to comment.