Add periods and remove ignore for linter rule

Signed-off-by: Spaceship Operations <[email protected]>

Author: SpaceshipOperations

pyproject.toml

@@ -83,8 +83,6 @@ ignore = [
     "D203",  # `one-blank-line-before-class` (D203) and `no-blank-line-before-class` (D211) are incompatible
     "D212",  # `multi-line-summary-first-line` (D212) and `multi-line-summary-second-line` (D213) are incompatible
     "S104",  # Possible binding to all interface
-    "D400",  # first line in docstring should end in a period
-    "D415",  # first line in docstring should end in a period, question mark or exclamation point
 ]
 [tool.ruff.per-file-ignores]
 "tests/**/*.py" = [

src/platformdirs/api.py

@@ -238,41 +238,41 @@ def site_runtime_path(self) -> Path:
         return Path(self.site_runtime_dir)
 
     def iter_config_dirs(self) -> Iterator[str]:
-        """:yield: all user and site configuration directories"""
+        """:yield: all user and site configuration directories."""
         yield self.user_config_dir
         yield self.site_config_dir
 
     def iter_data_dirs(self) -> Iterator[str]:
-        """:yield: all user and site data directories"""
+        """:yield: all user and site data directories."""
         yield self.user_data_dir
         yield self.site_data_dir
 
     def iter_cache_dirs(self) -> Iterator[str]:
-        """:yield: all user and site cache directories"""
+        """:yield: all user and site cache directories."""
         yield self.user_cache_dir
         yield self.site_cache_dir
 
     def iter_runtime_dirs(self) -> Iterator[str]:
-        """:yield: all user and site runtime directories"""
+        """:yield: all user and site runtime directories."""
         yield self.user_runtime_dir
         yield self.site_runtime_dir
 
     def iter_config_paths(self) -> Iterator[Path]:
-        """:yield: all user and site configuration paths"""
+        """:yield: all user and site configuration paths."""
         for path in self.iter_config_dirs():
             yield Path(path)
 
     def iter_data_paths(self) -> Iterator[Path]:
-        """:yield: all user and site data paths"""
+        """:yield: all user and site data paths."""
         for path in self.iter_data_dirs():
             yield Path(path)
 
     def iter_cache_paths(self) -> Iterator[Path]:
-        """:yield: all user and site cache paths"""
+        """:yield: all user and site cache paths."""
         for path in self.iter_cache_dirs():
             yield Path(path)
 
     def iter_runtime_paths(self) -> Iterator[Path]:
-        """:yield: all user and site runtime paths"""
+        """:yield: all user and site runtime paths."""
         for path in self.iter_runtime_dirs():
             yield Path(path)

src/platformdirs/unix.py

@@ -224,12 +224,12 @@ def _first_item_as_path_if_multipath(self, directory: str) -> Path:
         return Path(directory)
 
     def iter_config_dirs(self) -> Iterator[str]:
-        """:yield: all user and site configuration directories"""
+        """:yield: all user and site configuration directories."""
         yield self.user_config_dir
         yield from self._site_config_dirs
 
     def iter_data_dirs(self) -> Iterator[str]:
-        """:yield: all user and site data directories"""
+        """:yield: all user and site data directories."""
         yield self.user_data_dir
         yield from self._site_data_dirs