Skip to content

Commit 6b1278f

Browse files
authored
Merge branch 'stable' into fix-type-cast-sees-unset
2 parents 18d2919 + 06f52a4 commit 6b1278f

File tree

10 files changed

+331
-139
lines changed

10 files changed

+331
-139
lines changed

CHANGES.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@ Unreleased
1111
the ``Context.invoke()`` method. :issue:`3066` :issue:`3065` :pr:`3068`
1212
- Fix conversion of ``Sentinel.UNSET`` happening too early, which caused incorrect
1313
behavior for multiple parameters using the same name. :issue:`3071` :pr:`3079`
14+
- Fix rendering when ``prompt`` and ``confirm`` parameter ``prompt_suffix`` is
15+
empty. :issue:`3019` :pr:`3021`
1416
- When ``Sentinel.UNSET`` is found during parsing, it will skip calls to
15-
``type_cast_value``. :issue:`3069`
17+
``type_cast_value``. :issue:`3069` :pr:`3090`
1618

1719
Version 8.3.0
1820
--------------
Lines changed: 167 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,217 +1,353 @@
1-
API
2-
===
1+
# API
32

4-
.. module:: click
3+
```{currentmodule} click
4+
```
55

66
This part of the documentation lists the full API reference of all public
77
classes and functions.
88

9-
.. contents::
10-
:depth: 1
11-
:local:
9+
```{contents}
10+
:depth: 1
11+
:local: true
12+
```
1213

13-
Decorators
14-
----------
14+
## Decorators
1515

16+
```{eval-rst}
1617
.. autofunction:: command
18+
```
1719

20+
```{eval-rst}
1821
.. autofunction:: group
22+
```
1923

24+
```{eval-rst}
2025
.. autofunction:: argument
26+
```
2127

28+
```{eval-rst}
2229
.. autofunction:: option
30+
```
2331

32+
```{eval-rst}
2433
.. autofunction:: password_option
34+
```
2535

36+
```{eval-rst}
2637
.. autofunction:: confirmation_option
38+
```
2739

40+
```{eval-rst}
2841
.. autofunction:: version_option
42+
```
2943

44+
```{eval-rst}
3045
.. autofunction:: help_option
46+
```
3147

48+
```{eval-rst}
3249
.. autofunction:: pass_context
50+
```
3351

52+
```{eval-rst}
3453
.. autofunction:: pass_obj
54+
```
3555

56+
```{eval-rst}
3657
.. autofunction:: make_pass_decorator
58+
```
3759

60+
```{eval-rst}
3861
.. autofunction:: click.decorators.pass_meta_key
3962
63+
```
4064

41-
Utilities
42-
---------
65+
## Utilities
4366

67+
```{eval-rst}
4468
.. autofunction:: echo
69+
```
4570

71+
```{eval-rst}
4672
.. autofunction:: echo_via_pager
73+
```
4774

75+
```{eval-rst}
4876
.. autofunction:: prompt
77+
```
4978

79+
```{eval-rst}
5080
.. autofunction:: confirm
81+
```
5182

83+
```{eval-rst}
5284
.. autofunction:: progressbar
85+
```
5386

87+
```{eval-rst}
5488
.. autofunction:: clear
89+
```
5590

91+
```{eval-rst}
5692
.. autofunction:: style
93+
```
5794

95+
```{eval-rst}
5896
.. autofunction:: unstyle
97+
```
5998

99+
```{eval-rst}
60100
.. autofunction:: secho
101+
```
61102

103+
```{eval-rst}
62104
.. autofunction:: edit
105+
```
63106

107+
```{eval-rst}
64108
.. autofunction:: launch
109+
```
65110

111+
```{eval-rst}
66112
.. autofunction:: getchar
113+
```
67114

115+
```{eval-rst}
68116
.. autofunction:: pause
117+
```
69118

119+
```{eval-rst}
70120
.. autofunction:: get_binary_stream
121+
```
71122

123+
```{eval-rst}
72124
.. autofunction:: get_text_stream
125+
```
73126

127+
```{eval-rst}
74128
.. autofunction:: open_file
129+
```
75130

131+
```{eval-rst}
76132
.. autofunction:: get_app_dir
133+
```
77134

135+
```{eval-rst}
78136
.. autofunction:: format_filename
137+
```
79138

80-
Commands
81-
--------
139+
## Commands
82140

141+
```{eval-rst}
83142
.. autoclass:: BaseCommand
84143
:members:
144+
```
85145

146+
```{eval-rst}
86147
.. autoclass:: Command
87148
:members:
149+
```
88150

151+
```{eval-rst}
89152
.. autoclass:: MultiCommand
90153
:members:
154+
```
91155

156+
```{eval-rst}
92157
.. autoclass:: Group
93158
:members:
159+
```
94160

161+
```{eval-rst}
95162
.. autoclass:: CommandCollection
96163
:members:
164+
```
97165

98-
Parameters
99-
----------
166+
## Parameters
100167

168+
```{eval-rst}
101169
.. autoclass:: Parameter
102170
:members:
171+
```
103172

173+
```{eval-rst}
104174
.. autoclass:: Option
175+
```
105176

177+
```{eval-rst}
106178
.. autoclass:: Argument
179+
```
107180

108-
Context
109-
-------
181+
## Context
110182

183+
```{eval-rst}
111184
.. autoclass:: Context
112185
:members:
186+
```
113187

188+
```{eval-rst}
114189
.. autofunction:: get_current_context
190+
```
115191

192+
```{eval-rst}
116193
.. autoclass:: click.core.ParameterSource
117194
:members:
118195
:member-order: bysource
196+
```
119197

120-
.. _click-api-types:
198+
(click-api-types)=
121199

122-
Types
123-
-----
200+
## Types
124201

202+
```{eval-rst}
125203
.. autodata:: STRING
204+
```
126205

206+
```{eval-rst}
127207
.. autodata:: INT
208+
```
128209

210+
```{eval-rst}
129211
.. autodata:: FLOAT
212+
```
130213

214+
```{eval-rst}
131215
.. autodata:: BOOL
216+
```
132217

218+
```{eval-rst}
133219
.. autodata:: UUID
220+
```
134221

222+
```{eval-rst}
135223
.. autodata:: UNPROCESSED
224+
```
136225

226+
```{eval-rst}
137227
.. autoclass:: File
228+
```
138229

230+
```{eval-rst}
139231
.. autoclass:: Path
232+
```
140233

234+
```{eval-rst}
141235
.. autoclass:: Choice
142236
:members:
237+
```
143238

239+
```{eval-rst}
144240
.. autoclass:: IntRange
241+
```
145242

243+
```{eval-rst}
146244
.. autoclass:: FloatRange
245+
```
147246

247+
```{eval-rst}
148248
.. autoclass:: DateTime
249+
```
149250

251+
```{eval-rst}
150252
.. autoclass:: Tuple
253+
```
151254

255+
```{eval-rst}
152256
.. autoclass:: ParamType
153257
:members:
258+
```
154259

155-
Exceptions
156-
----------
260+
## Exceptions
157261

262+
```{eval-rst}
158263
.. autoexception:: ClickException
264+
```
159265

266+
```{eval-rst}
160267
.. autoexception:: Abort
268+
```
161269

270+
```{eval-rst}
162271
.. autoexception:: UsageError
272+
```
163273

274+
```{eval-rst}
164275
.. autoexception:: BadParameter
276+
```
165277

278+
```{eval-rst}
166279
.. autoexception:: FileError
280+
```
167281

282+
```{eval-rst}
168283
.. autoexception:: NoSuchOption
284+
```
169285

286+
```{eval-rst}
170287
.. autoexception:: BadOptionUsage
288+
```
171289

290+
```{eval-rst}
172291
.. autoexception:: BadArgumentUsage
292+
```
173293

174-
Formatting
175-
----------
294+
## Formatting
176295

296+
```{eval-rst}
177297
.. autoclass:: HelpFormatter
178298
:members:
299+
```
179300

301+
```{eval-rst}
180302
.. autofunction:: wrap_text
303+
```
181304

182-
Parsing
183-
-------
305+
## Parsing
184306

307+
```{eval-rst}
185308
.. autoclass:: OptionParser
186309
:members:
187310
311+
```
188312

189-
Shell Completion
190-
----------------
313+
## Shell Completion
191314

192-
See :doc:`/shell-completion` for information about enabling and
315+
See {doc}`/shell-completion` for information about enabling and
193316
customizing Click's shell completion system.
194317

318+
```{eval-rst}
195319
.. currentmodule:: click.shell_completion
320+
```
196321

322+
```{eval-rst}
197323
.. autoclass:: CompletionItem
324+
```
198325

326+
```{eval-rst}
199327
.. autoclass:: ShellComplete
200328
:members:
201329
:member-order: bysource
330+
```
202331

332+
```{eval-rst}
203333
.. autofunction:: add_completion_class
204334
335+
```
205336

206-
.. _testing:
337+
(testing)=
207338

208-
Testing
209-
-------
339+
## Testing
210340

341+
```{eval-rst}
211342
.. currentmodule:: click.testing
343+
```
212344

345+
```{eval-rst}
213346
.. autoclass:: CliRunner
214347
:members:
348+
```
215349

350+
```{eval-rst}
216351
.. autoclass:: Result
217352
:members:
353+
```

0 commit comments

Comments
 (0)