docs for future API #38
Merged
Conversation
This file contains hidden or 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
keszybz
reviewed
Apr 13, 2025
README.md
Outdated
| ### Test | ||
| Type `grader <DIR>`. This will start the grader interactive CLI. | ||
|
|
||
| If you get a bunch of info messages and a prompt, everything is setup correctly. |
README.md
Outdated
| A *disagreement* between reviewer1 and reviewer2 is an applicant for whom the two reviewers gave diverging grades, i.e.`1` and `-1`. After grading all motivations, you may want to go through all disagreements with other reviewers to check if you simply made a typo or if you really disagree. In case of a real disagreement, a discussion among reviewers will be needed. To go through all disagreements with reviewer `reviewer2` enter grading mode like this: | ||
| ``` | ||
| grader> grade -d reviewer2 |
Contributor
There was a problem hiding this comment.
Just grade -d. This goes through all reviewers.
Maybe add an example how to deal with one reviewer.
README.md
Outdated
| ## Use case: setting overrides | ||
| While grading you may notice that an applicant has misjudge for example their Python proficiency, by self-rating as `novice/advanced-beginner`, when instead you judge them to be rather `competent/proficient`. In this case you should set an override for this field in their application. You type `o python` while in grading mode. | ||
| Note that in grading mode you have tab-completion on applicant fields. Once the field is auto-completed, by hitting `<tab>` again you'll get a list of possible values to select from. This will set a permanent override for this applicant in the `applications.ini` |
README.md
Outdated
| To make this change permanent, you need to set the formula with: | ||
| ``` | ||
| grader> formula -s programming*0.2 + open_source*0.2 |
Contributor
There was a problem hiding this comment.
This goes against the design of the rest of grader, all state changes are "permanent" in the sense that they are saved to applications.ini on exit. The user is expected to have the files under git.
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.
No description provided.