Skip to content

Commit

Permalink
Update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
thombashi committed Mar 4, 2023
1 parent 07bf3e8 commit d2698c1
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions pathvalidate/_filename.py
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ def validate_filename(
ValidationError (ErrorReason.INVALID_CHARACTER):
If the ``filename`` includes invalid character(s) for a filename:
|invalid_filename_chars|.
The following characters are also invalid for Windows platform:
The following characters are also invalid for Windows platforms:
|invalid_win_filename_chars|.
ValidationError (ErrorReason.RESERVED_NAME):
If the ``filename`` equals reserved name by OS.
Expand Down Expand Up @@ -313,7 +313,7 @@ def sanitize_filename(
) -> PathType:
"""Make a valid filename from a string.
To make a valid filename the function does:
To make a valid filename, the function does the following:
- Replace invalid characters as file names included in the ``filename``
with the ``replacement_text``. Invalid characters are:
Expand Down
4 changes: 2 additions & 2 deletions pathvalidate/_filepath.py
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ def validate_filepath(
ValidationError (ErrorReason.INVALID_CHARACTER):
If the ``file_path`` includes invalid char(s):
|invalid_file_path_chars|.
The following characters are also invalid for Windows platform:
The following characters are also invalid for Windows platforms:
|invalid_win_file_path_chars|
ValidationError (ErrorReason.INVALID_LENGTH):
If the ``file_path`` is longer than ``max_len`` characters.
Expand Down Expand Up @@ -372,7 +372,7 @@ def sanitize_filepath(
) -> PathType:
"""Make a valid file path from a string.
To make a valid file path the function does:
To make a valid file path, the function does the following:
- replace invalid characters for a file path within the ``file_path``
with the ``replacement_text``. Invalid characters are as follows:
Expand Down

0 comments on commit d2698c1

Please sign in to comment.