Documentation Update for Schedule Generator #937
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* chore: create schedule sidebar panel header * style: also define appearance property in SchedulerPanelHeader.vue for compatability * docs: add inline docs to SchedulerPanelHeader * link icon w/header * link icon w/header * fix: style schedule-gen sidebar background and padding --------- Co-authored-by: Andrew J Xu <[email protected]>
* Run courses script for FA23 * Fix CS 1110 Frontend Test Corrects the CS 1110 frontend test with the new course title
* courses json * reqs
* disable generate * Generating... when generating schedule and fix max hour bug * lint * cleanup * credit limit and overflow * courses overflow * change warning * fix fonts * padding and font fix * cleanup --------- Co-authored-by: Nidhi Mylavarapu <[email protected]>
…926) * started req/sem filtering logic * undo changes * fixes * filter courses by sem from json * read sem courses only * lint * lint * fix: only show unique courses in requirement groups * adjusted for courses without meeting times * cleanup * add no requirement * fix test.spec.ts * lint --------- Co-authored-by: andxu282 <[email protected]> Co-authored-by: Simon Ilincev <[email protected]>
… in addition to readme
I believe the remaining lint issues are due to `console.log` and thus unavoidable
|
I would appreciate help in figuring out why the prettier checker is failing. |
Could you rebase off of main first? Then we can see your changes more clearly and diagnose the issue! |
|
See #938 . |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Added a lot of inline / method documentation to the schedule generator TypeScript backend algorithm. Also increased README.md by about 30% with additional details such as the exact implementation of the algorithm. Finally, added one line that randomizes courses' timeslots when being considered by the algorithm to ensure a higher-quality output.
Test Plan
Only documentation updates (no test plan required) except for one change: randomizing courses' timeslots in the algorithm to ensure that there is more variety in generated schedules. (Realized as I was writing up some of the documentation.)