From d3c26f8a81e2e02fa0d73de3670d41da8f3b8424 Mon Sep 17 00:00:00 2001
From: Eddy Chen <89349085+ecxyzzy@users.noreply.github.com>
Date: Thu, 28 Dec 2023 01:04:45 -0800
Subject: [PATCH] =?UTF-8?q?docs:=20=F0=9F=93=9A=EF=B8=8F=20add=20comments?=
 =?UTF-8?q?=20to=20types?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 packages/types/types/courses.ts    | 6 +++---
 packages/types/types/instructor.ts | 5 ++++-
 2 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/packages/types/types/courses.ts b/packages/types/types/courses.ts
index 540c0dbe..6e08779e 100644
--- a/packages/types/types/courses.ts
+++ b/packages/types/types/courses.ts
@@ -161,15 +161,15 @@ export type Course = {
    */
   terms: string[];
   /**
-   *
+   * The previews for the instructors that have taught this course in the past.
    */
   instructors: InstructorPreview[];
   /**
-   *
+   * The previews for the courses that are required to take this course.
    */
   prerequisites: CoursePreview[];
   /**
-   *
+   * The previews for the courses that require this course.
    */
   dependencies: CoursePreview[];
 };
diff --git a/packages/types/types/instructor.ts b/packages/types/types/instructor.ts
index 9d90c99c..f78822a7 100644
--- a/packages/types/types/instructor.ts
+++ b/packages/types/types/instructor.ts
@@ -45,7 +45,7 @@ export type Instructor = {
    */
   courseHistory: Record<string, string[]>;
   /**
-   *
+   * The previews for the course(s) this instructor has taught in the past.
    */
   courses: CoursePreview[];
 };
@@ -56,4 +56,7 @@ export type Instructor = {
  */
 export type Instructors = Instructor[];
 
+/**
+ * An object that contains a subset of an instructor's metadata, for preview purposes.
+ */
 export type InstructorPreview = Pick<Instructor, "ucinetid" | "name" | "shortenedName">;