Skip to content

Commit

Permalink
Final documentation tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
IanHopkinson committed Feb 8, 2024
1 parent b91c7cb commit fd5632f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/hdx/utilities/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,14 @@ def load_text(
replace_newlines (Optional[str]): String with which to replace newlines. Defaults to None (don't replace). (deprecated 2024-02-07)
replace_line_separators (Optional[str]): String with which to replace newlines. Defaults to None (don't replace).
loaderror_if_empty (bool): Whether to raise LoadError if file is empty. Default to True.
default_line_separator (str): line separator to be replaced if replace_newlines is True
default_line_separator (str): line separator to be replaced if replace_line_separators is not None
Returns:
str: String contents of file
"""
if replace_newlines is not None:
warn(
"Keyword argument 'replace_newlines' to 'load_text' is deprecated "
"Keyword argument 'replace_newlines' to 'load_text' is deprecated on 2024-02-08 "
"in favour of 'replace_line_separators'",
DeprecationWarning,
stacklevel=2,
Expand Down

0 comments on commit fd5632f

Please sign in to comment.