SlatePermutate Changeset - 069b10af1b36 · protofusion repositories

Changeset - 069b10af1b36

Parent rev.

Child rev.

[Not reviewed]

default

0 1 0

Nathan Brink (binki) - 14 years ago 2011-10-08 01:31:32
ohnobinki@ohnopublishing.net

Add some API documentation for the new crawling method.

1 file changed with 4 insertions and 3 deletions:

school.d/README.txt

0 comments (0 inline, 0 general)

school.d/README.txt

➞

Show inline comments

@@ @@ -126,16 +126,17 @@ each of these files are listed below: @@
   crawlable semesters for the school. Then
   <school_id>_crawl_semester_get() is called once for each semester.
 ** <school_id>_crawl_semester_list(array $school)
+** <school_id>_crawl_semester_list(array $school, array &$semesters)
   - $school: The school handle for <school_id>.
   Returns an array of Semester objects or FALSE on failure.
   - $semesters: An array to wh
   Returns 0 on success and nonzero on failure.
   This function should scrape the school's website and build a list of
   scrapable semesters. For each semester, it should instantiate a
   Semester object with metadata about that semester and then return an
   array of these Semester objects.
-** <school_id>_crawl_semester_get(array $school, Semester $semester)
+** <school_id>_crawl_semester(array $school, Semester $semester)
   - $school: The school handle for <school_id>
   - $semester: The semester object to which courses are added.
   Returns 0 on success and otherwise on failure.

0 comments (0 inline, 0 general)