search

kit-sdq / artemis4j

REST Client for the Artemis Project
Eclipse Public License 2.0
5 stars 6 forks source link

`Feature`: Add penalty-threshold to annotation #75

Open Shirkanesi opened 2 years ago

Shirkanesi commented 2 years ago

Is your feature request related to a problem? Please describe. The grading-tool allows to define a threshold after which points will get deduced (e.g. -1P when 3 annotations of same type are made). However this information is not properly visible in Artemis so in case a student starts a discussion about their deduction, instructors must keep track of the amount of such annotations made and then calculate the penalty.

Describe the solution you'd like Display this information in the annotation.

dfuchss commented 2 years ago

Sounds good. I guess that has to be modified in https://github.com/kit-sdq/programming-lecture-eclipse-artemis/blob/main/bundles/edu.kit.kastel.sdq.eclipse.common.core/src/edu/kit/kastel/sdq/eclipse/common/core/artemis/AnnotationMapper.java

Shirkanesi commented 2 years ago

Due to the current design, actually getting information about the threshold is not that easy (as the actual ThresholdPenaltyRule cannot be accessed that easily from the AnnotationMapper). I would suggest adding a String-Method "getPenaltyContext" (or similar) to PenaltyRule and use this output to put custom Strings in the annotations. (Basically the same concept as for the Tooltip-Text) Not the most beautiful solution but more dynamic than trying to get to the actual ThresholdPenaltyRule at this point.

I've created a quick draft of this idea here https://github.com/Shirkanesi/programming-lecture-eclipse-artemis/commit/345670ea7cc3f38f875d96e954ff99c9b63e869c

Oppinions?

We might also discuss the actual formatting of this information, as using an entire line in the feedback looks weird, just putting (x/y) at the end of the headline of each penalty looks weird also :(

dfuchss commented 2 years ago

Due to the current design, actually getting information about the threshold is not that easy (as the actual ThresholdPenaltyRule cannot be accessed that easily from the AnnotationMapper).

Actually I'm not happy with the current state of the serialization at all ; therefore, I'll have a look at this part when I find some time :) If you already have some idea how to make this better, feel free to create a proposal or write me a PM :)

dfuchss commented 3 months ago

@Feuermagier @Luro02 We can check whether we can include that to the new version of artemis4j or a follow-up PR :)