Add a brief docstring.

jaraco · Sep 8, 2024 · 91645cf · 91645cf
1 parent c006db4
commit 91645cf
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/jaraco/abode/config.py b/jaraco/abode/config.py
@@ -3,6 +3,8 @@
 
 class PlatformDirs(platformdirs.PlatformDirs):  # type: ignore[misc, valid-type] # platformdirs/platformdirs#295
     """
+    Augment PlatformDirs to ensure the data path exists.
+
     >>> dirs = PlatformDirs(appname='Abode', appauthor=False)
     >>> alt_udp = getfixture('tmp_path') / 'data' / 'dir'
     >>> vars(dirs).update(user_data_path=alt_udp)