Skip to content

Commit

Permalink
docs: Tell that members are still grouped by category when specifying…
Browse files Browse the repository at this point in the history
… members or members order options

Issue #119: #119
  • Loading branch information
pawamoy committed Jan 9, 2024
1 parent 4fe186f commit 03e53e3
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/usage/configuration/members.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ even if [`show_if_no_docstring`][] is set to false.

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

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

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

```yaml title="in mkdocs.yml (global configuration)"
plugins:
Expand Down

0 comments on commit 03e53e3

Please sign in to comment.