8000 docs: Tell that members are still grouped by category when specifying… · mkdocstrings/python@03e53e3 · GitHub
[go: up one dir, main page]

Skip to content

Commit 03e53e3

Browse files
committed
docs: Tell that members are still grouped by category when specifying members or members order options
Issue #119: #119
1 parent 4fe186f commit 03e53e3

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/usage/configuration/members.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ even if [`show_if_no_docstring`][] is set to false.
1414

1515
The members will be rendered in the specified order,
1616
regardless of the value of [`members_order`][].
17+
**Note that members will still be grouped by category,
18+
according to the [`group_by_category`][] option.**
1719

1820
Passing a falsy value (`no`, `false` in YAML) or an empty list (`[]`)
1921
will tell the Python handler not to render any member.
@@ -269,6 +271,8 @@ The members ordering to use. Possible values:
269271

270272
The order applies for all members, recursively.
271273
The order will be ignored for members that are explicitely sorted using the [`members`][] option.
274+
**Note that members will still be grouped by category,
275+
according to the [`group_by_category`][] option.**
272276

273277
```yaml title="in mkdocs.yml (global configuration)"
274278
plugins:

0 commit comments

Comments
 (0)
0