commit d5111a720733d2dcab9abdb94c0ab7377cdb6a9c
author Kemal Zebari <60799661+kemzeb@users.noreply.github.com> Thu Jun 22 18:41:24 2023 -0700
committer GitHub <noreply@github.com> Thu Jun 22 18:41:24 2023 -0700
tree ef28d10b918933d4e680fc6e716dd4c9fc5c22c1
parent a02fb045afa46a3f2bc17359bdd77e7d537aa382

Add missing user media directory docs (#195)

README.rst

diff --git a/README.rst b/README.rst
index 5df5db9..4db09e7 100644
--- a/README.rst
+++ b/README.rst
@@ -42,6 +42,9 @@
 - user log dir (``user_log_dir``)
 - user documents dir (``user_documents_dir``)
 - user downloads dir (``user_downloads_dir``)
+- user pictures dir (``user_pictures_dir``)
+- user videos dir (``user_videos_dir``)
+- user music dir (``user_music_dir``)
 - user runtime dir (``user_runtime_dir``)
 
 And also:
@@ -71,6 +74,12 @@
     '/Users/trentm/Documents'
     >>> user_downloads_dir()
     '/Users/trentm/Downloads'
+    >>> user_pictures_dir()
+    '/Users/trentm/Pictures'
+    >>> user_videos_dir()
+    '/Users/trentm/Movies'
+    >>> user_music_dir()
+    '/Users/trentm/Music'
     >>> user_runtime_dir(appname, appauthor)
     '/Users/trentm/Library/Caches/TemporaryItems/SuperApp'
 
@@ -93,6 +102,12 @@
     'C:\\Users\\trentm\\Documents'
     >>> user_downloads_dir()
     'C:\\Users\\trentm\\Downloads'
+    >>> user_pictures_dir()
+    'C:\\Users\\trentm\\Pictures'
+    >>> user_videos_dir()
+    'C:\\Users\\trentm\\Videos'
+    >>> user_music_dir()
+    'C:\\Users\\trentm\\Music'
     >>> user_runtime_dir(appname, appauthor)
     'C:\\Users\\trentm\\AppData\\Local\\Temp\\Acme\\SuperApp'
 
@@ -119,6 +134,12 @@
     '/home/trentm/Documents'
     >>> user_downloads_dir()
     '/home/trentm/Downloads'
+    >>> user_pictures_dir()
+    '/home/trentm/Pictures'
+    >>> user_videos_dir()
+    '/home/trentm/Videos'
+    >>> user_music_dir()
+    '/home/trentm/Music'
     >>> user_runtime_dir(appname, appauthor)
     '/run/user/{os.getuid()}/SuperApp'
     >>> site_config_dir(appname)
@@ -144,6 +165,12 @@
     '/storage/emulated/0/Documents'
     >>> user_downloads_dir()
     '/storage/emulated/0/Downloads'
+    >>> user_pictures_dir()
+    '/storage/emulated/0/Pictures'
+    >>> user_videos_dir()
+    '/storage/emulated/0/DCIM/Camera'
+    >>> user_music_dir()
+    '/storage/emulated/0/Music'
     >>> user_runtime_dir(appname, appauthor)
     '/data/data/com.myApp/cache/SuperApp/tmp'
 
@@ -173,6 +200,12 @@
     '/Users/trentm/Documents'
     >>> dirs.user_downloads_dir
     '/Users/trentm/Downloads'
+    >>> dirs.user_pictures_dir
+    '/Users/trentm/Pictures'
+    >>> dirs.user_videos_dir
+    '/Users/trentm/Movies'
+    >>> dirs.user_music_dir
+    '/Users/trentm/Music'
     >>> dirs.user_runtime_dir
     '/Users/trentm/Library/Caches/TemporaryItems/SuperApp'
 
@@ -197,6 +230,12 @@
     '/Users/trentm/Documents'
     >>> dirs.user_downloads_dir
     '/Users/trentm/Downloads'
+    >>> dirs.user_pictures_dir
+    '/Users/trentm/Pictures'
+    >>> dirs.user_videos_dir
+    '/Users/trentm/Movies'
+    >>> dirs.user_music_dir
+    '/Users/trentm/Music'
     >>> dirs.user_runtime_dir
     '/Users/trentm/Library/Caches/TemporaryItems/SuperApp/1.0'
 

docs/api.rst

diff --git a/docs/api.rst b/docs/api.rst
index 3d60bed..0e96b9c 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -48,6 +48,24 @@
 .. autofunction:: platformdirs.user_downloads_dir
 .. autofunction:: platformdirs.user_downloads_path
 
+User pictures directory
+------------------------
+
+.. autofunction:: platformdirs.user_pictures_dir
+.. autofunction:: platformdirs.user_pictures_path
+
+User videos directory
+------------------------
+
+.. autofunction:: platformdirs.user_videos_dir
+.. autofunction:: platformdirs.user_videos_path
+
+User music directory
+------------------------
+
+.. autofunction:: platformdirs.user_music_dir
+.. autofunction:: platformdirs.user_music_path
+
 Runtime directory
 -------------------