[LON-CAPA-cvs] cvs: loncom /interface loncommon.pm

[raeburn]

raeburn		Wed May 17 19:25:58 2006 EDT

  Modified files:              
    /loncom/interface	loncommon.pm 
  Log:
  Documentation updates for get_sections() and coursegroups() which should have accompanied rev 1.366 and rev 1.365 respectively.
  
  
Index: loncom/interface/loncommon.pm
diff -u loncom/interface/loncommon.pm:1.373 loncom/interface/loncommon.pm:1.374
--- loncom/interface/loncommon.pm:1.373	Wed May 17 19:13:47 2006
+++ loncom/interface/loncommon.pm	Wed May 17 19:25:56 2006
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # a pile of common routines
 #
-# $Id: loncommon.pm,v 1.373 2006/05/17 23:13:47 raeburn Exp $
+# $Id: loncommon.pm,v 1.374 2006/05/17 23:25:56 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -3760,13 +3760,14 @@
 
 Determines all the sections for a course including
 sections with students and sections containing other roles.
-Incoming parameters: domain, course number, reference to 
-section hash (keys to be section/group IDs), reference to 
-array containing roles for which sections should be gathered
-(optional). If the fourth argument is undefined, sections
-are gathered for any role.
+Incoming parameters: domain, course number, 
+reference to array containing roles for which sections should 
+be gathered (optional). If the third argument is undefined,
+sections are gathered for any role.
  
-Returns number of sections.
+Returns section hash (keys are section IDs, values are
+number of users in each section), subject to the
+optional roles filter.
 
 =cut
 
@@ -3822,10 +3823,9 @@
 Retrieve information about groups in a course,
 
 Input:
-1. Reference to hash to populate with group information. 
-2. Optional course domain
-3. Optional course number
-4. Optional group name
+1. Optional course domain
+2. Optional course number
+3. Optional group name
 
 Course domain and number will be taken from user's
 environment if not supplied. Optional group name will'
@@ -3833,15 +3833,14 @@
 use in the call to the dump function.
 
 Output
-Returns number of groups in the course (subject to the
-optional group name filter).
-
-Side effects:
-Populates the referenced curr_groups hash, with key,
-value pairs. Keys are group names, corresponding values
+Returns hash of groups in the course (subject to the
+optional group name filter). In the hash, the keys are
+group names, and their corresponding values
 are scalars containing group information in XML. This
-can be sent to &get_group_settings() to be parsed.     
+can be sent to &get_group_settings() to be parsed.
 
+Side effects:
+None.
 =cut 
 
 ###############################################