Fix and improve nusmoderator docs#2631
Conversation
taneliang
force-pushed
the
fix-moderator-docs
branch
from
609b45c to
265521c
Compare
Codecov Report
@@ Coverage Diff @@
## master #2631 +/- ##
=======================================
Coverage 46.18% 46.18%
=======================================
Files 244 244
Lines 5151 5151
Branches 1189 1189
=======================================
Hits 2379 2379
Misses 2772 2772 Continue to review full report at Codecov.
|
|
Deployment preview for |
| * - Instructional week 1: `weekNumber` = 1 | ||
| * - Instructional week 13: `weekNumber` = 13 | ||
| * - Examination week 2: `weekNumber` = 2 | ||
| * - Examination week 2: `weekNumber` = 2 |
There was a problem hiding this comment.
This is the same as the line above - is this suppose to be vacation?
|
|
||
| #### num | ||
|
|
||
| - **See: getAcadWeekInfo |
There was a problem hiding this comment.
This new line is inconvenient, although that seems like a bug in Documentation
| /** | ||
| * This `AcadWeek` is the `weekNumber`-th week with this academic week type | ||
| * in the semester. `null` if the semester has exactly 1 week of this type. | ||
| * Examples below: |
There was a problem hiding this comment.
A bit weird that this has more examples than the original docs on AcadWeek.weekNumber
2 participants
Context
As mentioned in #2630, it looks like nusmoderator's doc generation was broken by our TypeScript migration. documentation.js doesn't automatically pick up TS files.
Implementation
git diffto ensure that there are no changes.Other Information
#accept2ship