From 4e17cbc06589601d29ebd6685e79c389e118d53f Mon Sep 17 00:00:00 2001
From: Yuri Salimovskiy <yuri@packettide.com>
Date: Mon, 31 Jul 2023 10:54:41 +0300
Subject: [PATCH] Docs on memberlist tag usage

---
 docs/control-panel/settings/members.md |  9 ++++--
 docs/member/memberlist.md              | 41 ++++++++++++++++++++++++++
 2 files changed, 47 insertions(+), 3 deletions(-)

diff --git a/docs/control-panel/settings/members.md b/docs/control-panel/settings/members.md
index cc42a5b91..6c124fa37 100755
--- a/docs/control-panel/settings/members.md
+++ b/docs/control-panel/settings/members.md
@@ -77,19 +77,22 @@ The default member profile theme to be used in the Member Profile area of your s
 
 ![sort by](/_images/member_sort_by.png)
 
-Specifies the sorting criteria to be used. Choices are: Total Posts, Screen Name, Total Comments, Total Entries, Join Date.
+Specifies the default sorting criteria to be used by `{exp:members:memberlist}` tag. Choices are: Total Posts, Screen Name, Total Comments, Total Entries, Join Date.
+Can also be changed using [`memberlist_row_limit` configuration override](general/system-configuration-overrides.md#memberlist_row_limit).
 
 ### Order by
 
 ![order by](/_images/member_order_by.png)
 
-Specifies whether to show the list in _Ascending_ or _Descending_ order.
+Specifies whether to show the `{exp:members:memberlist}` list in _Ascending_ or _Descending_ order.
+Can also be changed using [`memberlist_order_by` configuration override](general/system-configuration-overrides.md#memberlist_order_by).
 
 ### Total results
 
 ![total results](/_images/member_total_results.png)
 
-Specifies the number of results to return by default.
+Specifies the number of results that `{exp:members:memberlist}` tag will display by default.
+Can also be changed using [`memberlist_row_limit` configuration override](general/system-configuration-overrides.md#memberlist_row_limit).
 
 ### Enable new member notifications?
 
diff --git a/docs/member/memberlist.md b/docs/member/memberlist.md
index cea7b4100..3a43a9f61 100644
--- a/docs/member/memberlist.md
+++ b/docs/member/memberlist.md
@@ -17,6 +17,47 @@ Outputs a searchable list of members, including form filters to sort and limit t
 
 ## Parameters
 
+### `role_id=`
+
+    role_id="5"
+
+Restrict the output to members that belong to certain [role](control-panel/member-manager.md#member-roles).
+
+### `orderby=`
+
+    orderby="screen_name"
+
+The "orderby" parameter sets the display order of members. The possible options for this parameter are the built-in member fields - including, but not limited to: 
+    - `member_id`
+    - `role_id`
+    - `screen_name`
+    - `email`
+    - `join_date`
+    - `last_visit`
+    - `last_activity`
+    - `total_entries`
+    - `total_comments`
+    - `last_entry_date`
+    - `last_comment_date`
+
+When not set, defaults to [Member List - Order](control-panel/settings/members.md#order-by)
+setting or [`memberlist_order_by` configuration override](general/system-configuration-overrides.md#memberlist_order_by)
+
+### `sort=`
+
+    sort="asc"
+    sort="desc"
+
+Set the order in which members are displayed.
+When not set, defaults to [Member List - Sort By](control-panel/settings/members.md#sort-by) setting or [`memberlist_sort_order` configuration override](general/system-configuration-overrides.md#memberlist_sort_order)
+
+### `limit=`
+
+    limit="30"
+
+Allows you to limit the number of members displayed.
+When not set, defaults to [Member List - Rows](control-panel/settings/members.md#total-results) setting or [`memberlist_row_limit` configuration override](general/system-configuration-overrides.md#memberlist_row_limit)
+
 ### `return=`
 
     return="member/memberlist"