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

feat: TL;DR implementation #144

Open
hemanialaparthi opened this issue Oct 23, 2024 · 1 comment
Open

feat: TL;DR implementation #144

hemanialaparthi opened this issue Oct 23, 2024 · 1 comment
Assignees

Comments

@hemanialaparthi
Copy link
Collaborator

Description: GatorGrader includes many commands, but many students, especially in introductory classes, are unfamiliar with most of them. To make it easier for students to understand and use GatorGrader, a --tldr option would be a helpful addition.

Solution:

The --tldr flag will offer two main features:

  • Running --tldr alone will display a summary of commonly used GatorGrader commands with example usage.
  • Running --tldr [specific command] will provide a detailed explanation and example for the specified command.

This addition will make GatorGrader more accessible to new users by offering quick reference information in a simplified format.

@hemanialaparthi hemanialaparthi self-assigned this Oct 23, 2024
@gkapfham
Copy link
Collaborator

Hello @hemanialaparthi it is also important to point out that many teachers who use GatorGrade as the front end for GatorGrader do now know the commands for using the tool, especially when it comes to writing the gatorgrade.yml file.

Here is an example:

- description: Ensure that Question 1 has correct number of documented functions using the command 'symbex'
  check: MatchCommandFragment
  options:
    command: "poetry run symbex -s --documented -f questions/question_one.py --count"
    fragment: 3
    count: 1
    exact: true

It would be nice if the --tldr actually gave examples of all of the various commands, like MatchCommandFragment that can be specified for running in a gatorgrade.yml file.

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

No branches or pull requests

2 participants