Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename the confusing operator field to subRequirementProgress #265

Merged
merged 1 commit into from
Feb 9, 2021

Conversation

SamChou19815
Copy link
Contributor

Summary

Close #138. This PR addresses the first and final unresolved issue in that github issue. The operator: 'and' | 'or' is very confusingly named and every time it took me a while to understand what they mean. This PR changes them to

subRequirementProgress: 'every-course-needed' | 'any-can-count'

I believe this wording can make the code reader know just be reading that this field tells how subrequirement progress stat is computed.

Test Plan

All requirements are computed as usual:

Screen Shot 2021-02-08 at 21 24 15

@SamChou19815 SamChou19815 requested a review from a team as a code owner February 9, 2021 02:28
@dti-github-bot
Copy link
Member

[diff-counting] Significant lines: 385.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 9, 2021

Visit the preview URL for this PR (updated for commit 4802aeb):

https://cornelldti-courseplan-dev--pr265-operator-to-subrequi-a4beu1nx.web.app

(expires Tue, 16 Feb 2021 02:30:40 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Copy link
Collaborator

@tcho6319 tcho6319 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. This naming seems much more intuitive. Thanks Sam!

@SamChou19815 SamChou19815 merged commit c1ac578 into master Feb 9, 2021
@SamChou19815 SamChou19815 deleted the operator-to-subrequirementprogress branch February 9, 2021 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Existing requirement computation issues
3 participants