Skip to content

Commit 22089f1

Browse files
authored
Add missing examples and fix order of examples in README (#355)
1 parent 29398b1 commit 22089f1

File tree

1 file changed

+39
-15
lines changed

1 file changed

+39
-15
lines changed

README.rst

Lines changed: 39 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,14 @@ On macOS:
7171
>>> appauthor = "Acme"
7272
>>> user_data_dir(appname, appauthor)
7373
'/Users/trentm/Library/Application Support/SuperApp'
74-
>>> site_data_dir(appname, appauthor)
75-
'/Library/Application Support/SuperApp'
74+
>>> user_config_dir(appname, appauthor)
75+
'/Users/trentm/Library/Application Support/SuperApp'
7676
>>> user_cache_dir(appname, appauthor)
7777
'/Users/trentm/Library/Caches/SuperApp'
78+
>>> site_data_dir(appname, appauthor)
79+
'/Library/Application Support/SuperApp'
80+
>>> site_config_dir(appname, appauthor)
81+
'/Library/Application Support/SuperApp'
7882
>>> user_log_dir(appname, appauthor)
7983
'/Users/trentm/Library/Logs/SuperApp'
8084
>>> user_documents_dir()
@@ -103,8 +107,14 @@ On Windows:
103107
'C:\\Users\\trentm\\AppData\\Local\\Acme\\SuperApp'
104108
>>> user_data_dir(appname, appauthor, roaming=True)
105109
'C:\\Users\\trentm\\AppData\\Roaming\\Acme\\SuperApp'
110+
>>> user_config_dir(appname, appauthor)
111+
'C:\\Users\\trentm\\AppData\\Local\\Acme\\SuperApp'
106112
>>> user_cache_dir(appname, appauthor)
107113
'C:\\Users\\trentm\\AppData\\Local\\Acme\\SuperApp\\Cache'
114+
>>> site_data_dir(appname, appauthor)
115+
'C:\\ProgramData\\Acme\\SuperApp'
116+
>>> site_config_dir(appname, appauthor)
117+
'C:\\ProgramData\\Acme\\SuperApp'
108118
>>> user_log_dir(appname, appauthor)
109119
'C:\\Users\\trentm\\AppData\\Local\\Acme\\SuperApp\\Logs'
110120
>>> user_documents_dir()
@@ -131,16 +141,21 @@ On Linux:
131141
>>> appauthor = "Acme"
132142
>>> user_data_dir(appname, appauthor)
133143
'/home/trentm/.local/share/SuperApp'
144+
>>> user_config_dir(appname)
145+
'/home/trentm/.config/SuperApp'
146+
>>> user_cache_dir(appname, appauthor)
147+
'/home/trentm/.cache/SuperApp'
134148
>>> site_data_dir(appname, appauthor)
135149
'/usr/local/share/SuperApp'
136150
>>> site_data_dir(appname, appauthor, multipath=True)
137151
'/usr/local/share/SuperApp:/usr/share/SuperApp'
138-
>>> user_cache_dir(appname, appauthor)
139-
'/home/trentm/.cache/SuperApp'
152+
>>> site_config_dir(appname)
153+
'/etc/xdg/SuperApp'
154+
>>> os.environ["XDG_CONFIG_DIRS"] = "/etc:/usr/local/etc"
155+
>>> site_config_dir(appname, multipath=True)
156+
'/etc/SuperApp:/usr/local/etc/SuperApp'
140157
>>> user_log_dir(appname, appauthor)
141158
'/home/trentm/.local/state/SuperApp/log'
142-
>>> user_config_dir(appname)
143-
'/home/trentm/.config/SuperApp'
144159
>>> user_documents_dir()
145160
'/home/trentm/Documents'
146161
>>> user_downloads_dir()
@@ -155,11 +170,6 @@ On Linux:
155170
'/home/trentm/Desktop'
156171
>>> user_runtime_dir(appname, appauthor)
157172
'/run/user/{os.getuid()}/SuperApp'
158-
>>> site_config_dir(appname)
159-
'/etc/xdg/SuperApp'
160-
>>> os.environ["XDG_CONFIG_DIRS"] = "/etc:/usr/local/etc"
161-
>>> site_config_dir(appname, multipath=True)
162-
'/etc/SuperApp:/usr/local/etc/SuperApp'
163173
164174
On Android::
165175

@@ -168,12 +178,16 @@ On Android::
168178
>>> appauthor = "Acme"
169179
>>> user_data_dir(appname, appauthor)
170180
'/data/data/com.myApp/files/SuperApp'
181+
>>> user_config_dir(appname)
182+
'/data/data/com.myApp/shared_prefs/SuperApp'
171183
>>> user_cache_dir(appname, appauthor)
172184
'/data/data/com.myApp/cache/SuperApp'
185+
>>> site_data_dir(appname, appauthor)
186+
'/data/data/com.myApp/files/SuperApp'
187+
>>> site_config_dir(appname)
188+
'/data/data/com.myApp/shared_prefs/SuperApp'
173189
>>> user_log_dir(appname, appauthor)
174190
'/data/data/com.myApp/cache/SuperApp/log'
175-
>>> user_config_dir(appname)
176-
'/data/data/com.myApp/shared_prefs/SuperApp'
177191
>>> user_documents_dir()
178192
'/storage/emulated/0/Documents'
179193
>>> user_downloads_dir()
@@ -205,8 +219,14 @@ apps also support ``XDG_*`` environment variables.
205219
>>> dirs = PlatformDirs("SuperApp", "Acme")
206220
>>> dirs.user_data_dir
207221
'/Users/trentm/Library/Application Support/SuperApp'
222+
>>> dirs.user_config_dir
223+
'/Users/trentm/Library/Application Support/SuperApp'
224+
>>> dirs.user_cache_dir
225+
'/Users/trentm/Library/Caches/SuperApp'
208226
>>> dirs.site_data_dir
209227
'/Library/Application Support/SuperApp'
228+
>>> dirs.site_config_dir
229+
'/Library/Application Support/SuperApp'
210230
>>> dirs.user_cache_dir
211231
'/Users/trentm/Library/Caches/SuperApp'
212232
>>> dirs.user_log_dir
@@ -237,10 +257,14 @@ dirs::
237257
>>> dirs = PlatformDirs("SuperApp", "Acme", version="1.0")
238258
>>> dirs.user_data_dir
239259
'/Users/trentm/Library/Application Support/SuperApp/1.0'
240-
>>> dirs.site_data_dir
241-
'/Library/Application Support/SuperApp/1.0'
260+
>>> dirs.user_config_dir
261+
'/Users/trentm/Library/Application Support/SuperApp/1.0'
242262
>>> dirs.user_cache_dir
243263
'/Users/trentm/Library/Caches/SuperApp/1.0'
264+
>>> dirs.site_data_dir
265+
'/Library/Application Support/SuperApp/1.0'
266+
>>> dirs.site_config_dir
267+
'/Library/Application Support/SuperApp/1.0'
244268
>>> dirs.user_log_dir
245269
'/Users/trentm/Library/Logs/SuperApp/1.0'
246270
>>> dirs.user_documents_dir

0 commit comments

Comments
 (0)