diff --git a/src/platformdirs/api.py b/src/platformdirs/api.py index ba0018e..c50caa6 100644 --- a/src/platformdirs/api.py +++ b/src/platformdirs/api.py @@ -58,7 +58,7 @@ def __init__( # noqa: PLR0913, PLR0917 That means that for users on a Windows network setup for roaming profiles, this user data will be synced on login (see - `here `_). + `here `_). """ self.multipath = multipath diff --git a/src/platformdirs/unix.py b/src/platformdirs/unix.py index bee1b8b..9500ade 100644 --- a/src/platformdirs/unix.py +++ b/src/platformdirs/unix.py @@ -6,13 +6,13 @@ import sys from configparser import ConfigParser from pathlib import Path -from typing import Iterator +from typing import Iterator, NoReturn from .api import PlatformDirsABC if sys.platform == "win32": - def getuid() -> int: + def getuid() -> NoReturn: msg = "should only be used on Unix" raise RuntimeError(msg) @@ -25,7 +25,7 @@ class Unix(PlatformDirsABC): # noqa: PLR0904 On Unix/Linux, we follow the `XDG Basedir Spec `_. - The spec allows overriding directories with environment variables. The examples show are the default values, + The spec allows overriding directories with environment variables. The examples shown are the default values, alongside the name of the environment variable that overrides them. Makes use of the `appname `, `version `, `multipath `, `opinion `, `ensure_exists diff --git a/src/platformdirs/windows.py b/src/platformdirs/windows.py index a4a13ea..8afb2a5 100644 --- a/src/platformdirs/windows.py +++ b/src/platformdirs/windows.py @@ -16,7 +16,7 @@ class Windows(PlatformDirsABC): """ - `MSDN on where to store app data files `_. Makes use of the `appname `, `appauthor