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: Check Grouping per File #167

Open
Chezka109 opened this issue Dec 6, 2024 · 2 comments
Open

feat: Check Grouping per File #167

Chezka109 opened this issue Dec 6, 2024 · 2 comments

Comments

@Chezka109
Copy link
Collaborator

Description:
Currently, when GatorGrade runs checks, it lists them without grouping by the file in which they are being run. This makes it harder to identify which checks belong to which file, especially when dealing with a large number of checks across multiple files.

Expected Behavior:
When GatorGrade runs, the checks should be grouped by the file they pertain to. For example:

File: questions/question_one.py:
      ✔  Check 1: Passed  
      ✘  Check 2: Failed  

File: main.py  
       ✔ Check 1: Passed  
       ✔ Check 2: Passed  

This organization improves readability and makes it easier to debug issues.

Actual Behavior:
All checks are listed sequentially without clear indication of which file they belong to. This lack of grouping can make the output hard to interpret, particularly for complex projects.

Proposed Solution:
Modify the logic in output.py to organize checks by file. The solution involves:

  1. Identifying which file each check corresponds to during the check process.
  2. Grouping and formatting the output in output.py to display checks under the respective file name.
  3. Testing the implementation to ensure that grouped output displays correctly for various project structures.
@Chezka109
Copy link
Collaborator Author

@dyga01, here is the issue for the Check Grouping feature we talked about in class today!

@dyga01
Copy link
Collaborator

dyga01 commented Dec 6, 2024

@Chezka109 Thanks for making this issue per our discussion in class. I think that we now need to determine how the checks should be grouped. I could try and allow for instructors to add an option called group that would allow instructors to group checks themselves and then display the rest of the checks being displayed as "other". What do you think about this?

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