Skip to content

Commit 1a40121

Browse files
authored
Fix docs for site_cache_dir (#402)
* Fix docs for `site_cache_dir` * Clean up documentation grammar
1 parent 8ef6a57 commit 1a40121

File tree

6 files changed

+9
-9
lines changed

6 files changed

+9
-9
lines changed

src/platformdirs/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ def site_config_dir(
135135
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
136136
:param multipath: See `roaming <platformdirs.api.PlatformDirsABC.multipath>`.
137137
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
138-
:returns: config directory shared by the users
138+
:returns: config directory shared by users
139139
"""
140140
return PlatformDirs(
141141
appname=appname,
@@ -405,7 +405,7 @@ def site_config_path(
405405
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
406406
:param multipath: See `roaming <platformdirs.api.PlatformDirsABC.multipath>`.
407407
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
408-
:returns: config path shared by the users
408+
:returns: config path shared by users
409409
"""
410410
return PlatformDirs(
411411
appname=appname,
@@ -429,7 +429,7 @@ def site_cache_path(
429429
:param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
430430
:param opinion: See `opinion <platformdirs.api.PlatformDirsABC.opinion>`.
431431
:param ensure_exists: See `ensure_exists <platformdirs.api.PlatformDirsABC.ensure_exists>`.
432-
:returns: cache directory tied to the user
432+
:returns: cache directory shared by users
433433
"""
434434
return PlatformDirs(
435435
appname=appname,

src/platformdirs/android.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ def user_config_dir(self) -> str:
4040

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

4646
@property

src/platformdirs/api.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ def user_config_dir(self) -> str:
116116
@property
117117
@abstractmethod
118118
def site_config_dir(self) -> str:
119-
""":return: config directory shared by the users"""
119+
""":return: config directory shared by users"""
120120

121121
@property
122122
@abstractmethod
@@ -195,7 +195,7 @@ def user_config_path(self) -> Path:
195195

196196
@property
197197
def site_config_path(self) -> Path:
198-
""":return: config path shared by the users"""
198+
""":return: config path shared by users"""
199199
return Path(self.site_config_dir)
200200

201201
@property

src/platformdirs/macos.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ def user_config_dir(self) -> str:
5959

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

6565
@property

src/platformdirs/unix.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ def site_data_path(self) -> Path:
211211

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

217217
@property

src/platformdirs/windows.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ def user_config_dir(self) -> str:
6363

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

6969
@property

0 commit comments

Comments
 (0)