docs: 📚️ add comments to types

icssc · Dec 28, 2023 · d3c26f8 · d3c26f8
1 parent fa9910e
commit d3c26f8
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git 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
@@ -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">;