Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 3.08 KB

cmdDocumentation.md

File metadata and controls

46 lines (33 loc) · 3.08 KB
Raw

CLI Documentation

For more information click here.

  • userClearCourseList; Clear the user's course list.
  • clearScheduleList; Clear the user's schedule list.
  • rmCourse; Remove given course from the course list. It takes one arg, which is the course code.
  • rmWish; Remove given wish from the course list. It takes one arg, which is the course code.
  • getCourseList; Give course list.
  • getWishList; Give wish list.
  • getScheduleList; Give schedule list.
  • addCourse; Add given course to the course list. It takes one arg, which is the course code.
    • eg. addCourse CSC207FLEC0101 or addCourse CSC207F. (Note for Phase 0, please use the former format, as it is manually scheduling the courses)
  • addWish; Add given course to the wish list. It takes one arg, which is the course code.
  • getLatestSchedule; Give the latest schedule in the user account.
  • getCourseGeneralInformation; Give the course information summary. It takes one arg, which is the course code.
  • getSectionInformation; Give the section information summary. It takes one arg, which is the course code.
  • planCourse; Plan the course. Note that, the algorithm would prioritize the course in the course list, then schedule the ones in wish list.
    • Special note for Phase 0: the current algorithm requires Manual scheduling, the auto-scheduling is for preview. Please check our branch for details.
  • presentCalendar; Show the calendar for the latest schedule. It takes two args. First one is for the term type (F/S/Y). Second one is for the calendar type (Workday, etc.)
    • Note that, for term arg, F or S would give one single calendar while Y gives both.
      • eg. presentCalendar F Workday

Special note on review service, to make sure you write a review successfully, you will need to ensure there are existing course review and instructor review existing in the database. If not, you may want to create one.

  • createNewCourse; Create a course review. It takes one arg, which is the course code.
  • createNewInst; Create an instructor review. It takes two args, which are the course code and the instructor name.
  • createNewUserReview; Create a user review. It takes 5 args, which are courseCode, instName, generalRate, difficultyRate, reviewString.
  • deleteUserReview; Delete your review. It takes 2 args, which are courseCode, instName.
  • editUserReview; Edit a user review. It takes 5 args, which are courseCode, instName, generalRate, difficultyRate, reviewString.
  • getExistingCourseList; Give you the existing courses in the database;
  • getInstRank; Give you an instructor rank for a course. It takes in 1 arg, which is the course code.
  • getInstReviewSummary; Give you an instructor review summary for a course. It takes in 1 arg, which is the course code.
  • getUserReviewSummary; Give you an instructor review summary for an instructor. It takes in 2 args, which are the course code and the instructor name.

For more information click here.

Please Enjoy,

Team bugMaker