Skip to content

Commit 0e0ada3

Browse files
committed
update docs
1 parent aa35e84 commit 0e0ada3

File tree

3 files changed

+8
-6
lines changed

3 files changed

+8
-6
lines changed

docs/api.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ API Reference
1414
OptionGroup
1515

1616
RequiredAnyOptionGroup
17+
AllOptionGroup
1718
RequiredAllOptionGroup
1819
MutuallyExclusiveOptionGroup
1920
RequiredMutuallyExclusiveOptionGroup

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Contents
6767
.. toctree::
6868
:maxdepth: 2
6969

70-
manual
70+
tutorial
7171
api
7272
changelog
7373

docs/manual.rst renamed to docs/tutorial.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
.. _manual.:
1+
.. _tutorial:
22

3-
Manual
4-
======
3+
Tutorial
4+
========
55

66
A Simple Example
77
----------------
@@ -199,8 +199,9 @@ Both these classes do not contain the specific behavior or relationship among gr
199199
The specific behavior can be implemented by using the inheritance, mainly, in :class:`OptionGroup` sub classes.
200200
**click-option-groups** provides some useful :class:`OptionGroup` based classes out of the box:
201201

202-
- :class:`RequiredAnyOptionGroup` -- At least one option from the group must be set.
203-
- :class:`RequiredAllOptionGroup` -- All options from the group must be set.
202+
- :class:`RequiredAnyOptionGroup` -- At least one option from the group must be set
203+
- :class:`AllOptionGroup` -- All options from the group must be set or none must be set
204+
- :class:`RequiredAllOptionGroup` -- All options from the group must be set
204205
- :class:`MutuallyExclusiveOptionGroup` -- Only one or none option from the group must be set
205206
- :class:`RequiredMutuallyExclusiveOptionGroup` -- Only one required option from the group must be set
206207

0 commit comments

Comments
 (0)