From 5a21c6670f786f497feda8caeb17540fdb13844d Mon Sep 17 00:00:00 2001
From: Ting-Jun Wang <levi900227@gmail.com>
Date: Wed, 30 Jun 2021 11:03:53 +0800
Subject: [PATCH] docs: Add comment

---
 api/moodle.py | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/api/moodle.py b/api/moodle.py
index 2782578..5700284 100644
--- a/api/moodle.py
+++ b/api/moodle.py
@@ -44,8 +44,8 @@ class Moodle():
     
     def getCourses(self, semester):
         '''
-            Get Courses link in this semester.
-            Return a list including {
+            取得該學年的所有課程列表
+            Return {
                 'id',
                 'name'
             }
@@ -63,7 +63,8 @@ class Moodle():
     
     def getUpcomingEvents(self):
         '''
-            Get Upcomming Events
+            取得 Event 列表
+            僅包含 ID、大標題、時間
         '''
         response = self.session.get('https://moodle.ncnu.edu.tw/')
         events = findAll(response, 'div', {'class': 'event'})
@@ -80,6 +81,7 @@ class Moodle():
     def getEvent(self, eventId):
         '''
             取得單一 Event 的細節
+            額外取得 Description、課程資訊
         '''
         url = "https://moodle.ncnu.edu.tw/lib/ajax/service.php?sesskey={}&info=core_calendar_get_calendar_event_by_id"
         data = [