Skip to content

Commit ef1267e

Browse files
[pre-commit.ci] pre-commit autoupdate (#497)
<!--pre-commit.ci start--> updates: - [github.com/tox-dev/pyproject-fmt: v2.24.1 → v2.25.0](tox-dev/pyproject-fmt@v2.24.1...v2.25.0) - [github.com/astral-sh/ruff-pre-commit: v0.15.17 → v0.15.18](astral-sh/ruff-pre-commit@v0.15.17...v0.15.18) - [github.com/LilSpazJoekp/docstrfmt: v2.1.1 → v2.2.0](LilSpazJoekp/docstrfmt@v2.1.1...v2.2.0) - [github.com/zizmorcore/zizmor-pre-commit: v1.25.2 → v1.26.1](zizmorcore/zizmor-pre-commit@v1.25.2...v1.26.1) <!--pre-commit.ci end--> --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Bernát Gábor <gaborjbernat@gmail.com>
1 parent 87d76e0 commit ef1267e

8 files changed

Lines changed: 230 additions & 226 deletions

File tree

.pre-commit-config.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ repos:
1919
hooks:
2020
- id: tox-toml-fmt
2121
- repo: https://github.com/tox-dev/pyproject-fmt
22-
rev: "v2.24.1"
22+
rev: "v2.25.0"
2323
hooks:
2424
- id: pyproject-fmt
2525
- repo: https://github.com/astral-sh/ruff-pre-commit
26-
rev: "v0.15.17"
26+
rev: "v0.15.18"
2727
hooks:
2828
- id: ruff-format
2929
- id: ruff-check
@@ -43,13 +43,13 @@ repos:
4343
- mdformat-gfm>=1
4444
- mdformat-ruff>=0.1.3
4545
- repo: https://github.com/LilSpazJoekp/docstrfmt
46-
rev: v2.1.1
46+
rev: v2.2.0
4747
hooks:
4848
- id: docstrfmt
4949
args: ["-l", "120"]
5050
additional_dependencies: ["sphinx>=9.1"]
5151
- repo: https://github.com/zizmorcore/zizmor-pre-commit
52-
rev: v1.25.2
52+
rev: v1.26.1
5353
hooks:
5454
- id: zizmor
5555
- repo: meta

docs/api.rst

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ These are user-specific (and, generally, user-writeable) directories.
1111
User data directory
1212
===================
1313

14-
See also: :ref:`platforms:``user_data_dir```
14+
See also: :ref:`platforms:\`\`user_data_dir\`\``
1515

1616
.. autofunction:: platformdirs.user_data_dir
1717

@@ -20,7 +20,7 @@ See also: :ref:`platforms:``user_data_dir```
2020
User config directory
2121
=====================
2222

23-
See also: :ref:`platforms:``user_config_dir```
23+
See also: :ref:`platforms:\`\`user_config_dir\`\``
2424

2525
.. autofunction:: platformdirs.user_config_dir
2626

@@ -29,7 +29,7 @@ See also: :ref:`platforms:``user_config_dir```
2929
User cache directory
3030
====================
3131

32-
See also: :ref:`platforms:``user_cache_dir```
32+
See also: :ref:`platforms:\`\`user_cache_dir\`\``
3333

3434
.. autofunction:: platformdirs.user_cache_dir
3535

@@ -38,7 +38,7 @@ See also: :ref:`platforms:``user_cache_dir```
3838
User state directory
3939
====================
4040

41-
See also: :ref:`platforms:``user_state_dir```
41+
See also: :ref:`platforms:\`\`user_state_dir\`\``
4242

4343
.. autofunction:: platformdirs.user_state_dir
4444

@@ -47,7 +47,7 @@ See also: :ref:`platforms:``user_state_dir```
4747
User log directory
4848
==================
4949

50-
See also: :ref:`platforms:``user_log_dir```
50+
See also: :ref:`platforms:\`\`user_log_dir\`\``
5151

5252
.. autofunction:: platformdirs.user_log_dir
5353

@@ -56,7 +56,7 @@ See also: :ref:`platforms:``user_log_dir```
5656
User runtime directory
5757
======================
5858

59-
See also: :ref:`platforms:``user_runtime_dir```
59+
See also: :ref:`platforms:\`\`user_runtime_dir\`\``
6060

6161
.. autofunction:: platformdirs.user_runtime_dir
6262

@@ -65,7 +65,7 @@ See also: :ref:`platforms:``user_runtime_dir```
6565
User applications directory
6666
===========================
6767

68-
See also: :ref:`platforms:``user_applications_dir```
68+
See also: :ref:`platforms:\`\`user_applications_dir\`\``
6969

7070
Where application launchers and shortcuts are registered — ``.desktop`` files on Linux, the per-user ``Applications``
7171
folder on macOS, or Start Menu shortcuts on Windows. These entries make applications discoverable in menus and app
@@ -78,7 +78,7 @@ launchers.
7878
User binary directory
7979
=====================
8080

81-
See also: :ref:`platforms:``user_bin_dir```
81+
See also: :ref:`platforms:\`\`user_bin_dir\`\``
8282

8383
Where user-installed executables and scripts are placed so they appear on ``$PATH`` — ``~/.local/bin`` on Linux/macOS or
8484
``%LOCALAPPDATA%\Programs`` on Windows.
@@ -90,7 +90,7 @@ Where user-installed executables and scripts are placed so they appear on ``$PAT
9090
User documents directory
9191
========================
9292

93-
See also: :ref:`platforms:``user_documents_dir```
93+
See also: :ref:`platforms:\`\`user_documents_dir\`\``
9494

9595
.. autofunction:: platformdirs.user_documents_dir
9696

@@ -99,7 +99,7 @@ See also: :ref:`platforms:``user_documents_dir```
9999
User downloads directory
100100
========================
101101

102-
See also: :ref:`platforms:``user_downloads_dir```
102+
See also: :ref:`platforms:\`\`user_downloads_dir\`\``
103103

104104
.. autofunction:: platformdirs.user_downloads_dir
105105

@@ -108,7 +108,7 @@ See also: :ref:`platforms:``user_downloads_dir```
108108
User pictures directory
109109
=======================
110110

111-
See also: :ref:`platforms:``user_pictures_dir```
111+
See also: :ref:`platforms:\`\`user_pictures_dir\`\``
112112

113113
.. autofunction:: platformdirs.user_pictures_dir
114114

@@ -117,7 +117,7 @@ See also: :ref:`platforms:``user_pictures_dir```
117117
User videos directory
118118
=====================
119119

120-
See also: :ref:`platforms:``user_videos_dir```
120+
See also: :ref:`platforms:\`\`user_videos_dir\`\``
121121

122122
.. autofunction:: platformdirs.user_videos_dir
123123

@@ -126,7 +126,7 @@ See also: :ref:`platforms:``user_videos_dir```
126126
User music directory
127127
====================
128128

129-
See also: :ref:`platforms:``user_music_dir```
129+
See also: :ref:`platforms:\`\`user_music_dir\`\``
130130

131131
.. autofunction:: platformdirs.user_music_dir
132132

@@ -135,7 +135,7 @@ See also: :ref:`platforms:``user_music_dir```
135135
User desktop directory
136136
======================
137137

138-
See also: :ref:`platforms:``user_desktop_dir```
138+
See also: :ref:`platforms:\`\`user_desktop_dir\`\``
139139

140140
.. autofunction:: platformdirs.user_desktop_dir
141141

@@ -144,7 +144,7 @@ See also: :ref:`platforms:``user_desktop_dir```
144144
User projects directory
145145
=======================
146146

147-
See also: :ref:`platforms:``user_projects_dir```
147+
See also: :ref:`platforms:\`\`user_projects_dir\`\``
148148

149149
.. autofunction:: platformdirs.user_projects_dir
150150

@@ -153,7 +153,7 @@ See also: :ref:`platforms:``user_projects_dir```
153153
User public share directory
154154
===========================
155155

156-
See also: :ref:`platforms:``user_publicshare_dir```
156+
See also: :ref:`platforms:\`\`user_publicshare_dir\`\``
157157

158158
.. autofunction:: platformdirs.user_publicshare_dir
159159

@@ -162,7 +162,7 @@ See also: :ref:`platforms:``user_publicshare_dir```
162162
User templates directory
163163
========================
164164

165-
See also: :ref:`platforms:``user_templates_dir```
165+
See also: :ref:`platforms:\`\`user_templates_dir\`\``
166166

167167
.. autofunction:: platformdirs.user_templates_dir
168168

@@ -171,7 +171,7 @@ See also: :ref:`platforms:``user_templates_dir```
171171
User fonts directory
172172
====================
173173

174-
See also: :ref:`platforms:``user_fonts_dir```
174+
See also: :ref:`platforms:\`\`user_fonts_dir\`\``
175175

176176
.. autofunction:: platformdirs.user_fonts_dir
177177

@@ -180,7 +180,7 @@ See also: :ref:`platforms:``user_fonts_dir```
180180
User preference directory
181181
=========================
182182

183-
See also: :ref:`platforms:``user_preference_dir```
183+
See also: :ref:`platforms:\`\`user_preference_dir\`\``
184184

185185
.. autofunction:: platformdirs.user_preference_dir
186186

@@ -195,7 +195,7 @@ These are system-wide (and, generally, read-only) directories.
195195
Shared data directory
196196
=====================
197197

198-
See also: :ref:`platforms:``site_data_dir```
198+
See also: :ref:`platforms:\`\`site_data_dir\`\``
199199

200200
.. autofunction:: platformdirs.site_data_dir
201201

@@ -204,7 +204,7 @@ See also: :ref:`platforms:``site_data_dir```
204204
Shared config directory
205205
=======================
206206

207-
See also: :ref:`platforms:``site_config_dir```
207+
See also: :ref:`platforms:\`\`site_config_dir\`\``
208208

209209
.. autofunction:: platformdirs.site_config_dir
210210

@@ -213,7 +213,7 @@ See also: :ref:`platforms:``site_config_dir```
213213
Shared cache directory
214214
======================
215215

216-
See also: :ref:`platforms:``site_cache_dir```
216+
See also: :ref:`platforms:\`\`site_cache_dir\`\``
217217

218218
.. autofunction:: platformdirs.site_cache_dir
219219

@@ -222,7 +222,7 @@ See also: :ref:`platforms:``site_cache_dir```
222222
Shared state directory
223223
======================
224224

225-
See also: :ref:`platforms:``site_state_dir```
225+
See also: :ref:`platforms:\`\`site_state_dir\`\``
226226

227227
.. autofunction:: platformdirs.site_state_dir
228228

@@ -231,7 +231,7 @@ See also: :ref:`platforms:``site_state_dir```
231231
Shared log directory
232232
====================
233233

234-
See also: :ref:`platforms:``site_log_dir```
234+
See also: :ref:`platforms:\`\`site_log_dir\`\``
235235

236236
.. autofunction:: platformdirs.site_log_dir
237237

@@ -240,7 +240,7 @@ See also: :ref:`platforms:``site_log_dir```
240240
Shared runtime directory
241241
========================
242242

243-
See also: :ref:`platforms:``site_runtime_dir```
243+
See also: :ref:`platforms:\`\`site_runtime_dir\`\``
244244

245245
.. autofunction:: platformdirs.site_runtime_dir
246246

@@ -249,7 +249,7 @@ See also: :ref:`platforms:``site_runtime_dir```
249249
Shared applications directory
250250
=============================
251251

252-
See also: :ref:`platforms:``site_applications_dir```
252+
See also: :ref:`platforms:\`\`site_applications_dir\`\``
253253

254254
Where application launchers and shortcuts are registered system-wide — ``.desktop`` files in ``/usr/share/applications``
255255
on Linux, ``/Applications`` on macOS, or the All Users Start Menu on Windows. Applications installed here are available
@@ -262,7 +262,7 @@ to all users.
262262
Shared binary directory
263263
=======================
264264

265-
See also: :ref:`platforms:``site_bin_dir```
265+
See also: :ref:`platforms:\`\`site_bin_dir\`\``
266266

267267
Where system-wide executables and scripts are placed — ``/usr/local/bin`` on Linux/macOS or ``%ProgramData%\bin`` on
268268
Windows. Executables here are available to all users.

0 commit comments

Comments
 (0)