Fixed documentation rd_listgroups

This commit is contained in:
Todd Baker 2018-09-11 10:00:29 -04:00
parent 5179ba9563
commit adc034a3eb
2 changed files with 8 additions and 3 deletions

View File

@ -17634,3 +17634,7 @@
2018-09-10 Fred Gleason <fredg@paravelsystems.com>
* Quadrupled the length of strings in 'struct rd_cart' in the
'rivwebcapi' to accomodate UTF-8 characters.
2018-09-11 Todd Baker <bakert@rfa.org>
* Updated docs/rivwebcapi/rd_listgroups.xml to explicitly explain
that rd_listgroups shows all groups that the requesting user belongs to.

View File

@ -47,11 +47,12 @@
<refsect1 id='description'><title>Description</title>
<para>
<command>RD_ListGroups</command> is the function to use
to list the fields that are stored for a particular group within the Rivendell Database.
<command>RD_ListGroups</command> is the function to use
to list the fields that are stored for a user's groups within the Rivendell Database.
</para>
<para>
This function lists the fields in all pre-existing Groups.
This function lists the fields in all pre-existing Groups for the Requesting User. Lists
the group fields for each group that the User has permission to see.
</para>
<table xml:id="ex.listgroup" frame="all">
<title>RD_ListGroups function call fields</title>