Skip to content

Fix docs for site_cache_dir #402

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+10 −10
Open

Fix docs for site_cache_dir #402

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5da8ec3
Fix docs for `site_cache_dir`
brianhelba Dec 2, 2025
f296ca8
Clean up documentation grammar
brianhelba Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/platformdirs/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ def site_config_dir(
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
:param multipath: See `roaming <platformdirs.api.PlatformDirsABC.multipath>`.
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
:returns: config directory shared by the users
:returns: config directory shared by users
"""
return PlatformDirs(
appname=appname,
Expand Down Expand Up @@ -183,7 +183,7 @@ def site_cache_dir(
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
:param opinion: See `opinion <platformdirs.api.PlatformDirsABC.opinion>`.
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
:returns: cache directory tied to the user
:returns: cache directory shared by users
"""
return PlatformDirs(
appname=appname,
Expand Down Expand Up @@ -405,7 +405,7 @@ def site_config_path(
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
:param multipath: See `roaming <platformdirs.api.PlatformDirsABC.multipath>`.
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
:returns: config path shared by the users
:returns: config path shared by users
"""
return PlatformDirs(
appname=appname,
Expand All @@ -429,7 +429,7 @@ def site_cache_path(
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
:param opinion: See `opinion <platformdirs.api.PlatformDirsABC.opinion>`.
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
:returns: cache directory tied to the user
:returns: cache directory shared by users
"""
return PlatformDirs(
appname=appname,
Expand Down
2 changes: 1 addition & 1 deletion src/platformdirs/android.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def user_config_dir(self) -> str:

@property
def site_config_dir(self) -> str:
""":return: config directory shared by the users, same as `user_config_dir`"""
""":return: config directory shared by users, same as `user_config_dir`"""
return self.user_config_dir

@property
Expand Down
4 changes: 2 additions & 2 deletions src/platformdirs/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ def user_config_dir(self) -> str:
@property
@abstractmethod
def site_config_dir(self) -> str:
""":return: config directory shared by the users"""
""":return: config directory shared by users"""

@property
@abstractmethod
Expand Down Expand Up @@ -195,7 +195,7 @@ def user_config_path(self) -> Path:

@property
def site_config_path(self) -> Path:
""":return: config path shared by the users"""
""":return: config path shared by users"""
return Path(self.site_config_dir)

@property
Expand Down
2 changes: 1 addition & 1 deletion src/platformdirs/macos.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ def user_config_dir(self) -> str:

@property
def site_config_dir(self) -> str:
""":return: config directory shared by the users, same as `site_data_dir`"""
""":return: config directory shared by users, same as `site_data_dir`"""
return self.site_data_dir

@property
Expand Down
2 changes: 1 addition & 1 deletion src/platformdirs/unix.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ def site_data_path(self) -> Path:

@property
def site_config_path(self) -> Path:
""":return: config path shared by the users, returns the first item, even if ``multipath`` is set to ``True``"""
""":return: config path shared by users, returns the first item, even if ``multipath`` is set to ``True``"""
return self._first_item_as_path_if_multipath(self.site_config_dir)

@property
Expand Down
2 changes: 1 addition & 1 deletion src/platformdirs/windows.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ def user_config_dir(self) -> str:

@property
def site_config_dir(self) -> str:
""":return: config directory shared by the users, same as `site_data_dir`"""
""":return: config directory shared by users, same as `site_data_dir`"""
return self.site_data_dir

@property
Expand Down