nus-cs2113-AY2021S1 / pe-dev-response

0 stars 0 forks source link

Lack of explanation in the feature of set S/U by semester #264

Open nus-pe-bot opened 3 years ago

nus-pe-bot commented 3 years ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.


In the explanation part about the feature of set S/U by semester in the UG, the explanation about the modules shown at last that the user should S/U in order to obtain the highest CAP possible is too brief. The criteria deciding it is not explained in details. In some examples, all modules with grades below A would be included in the S/U list and shown like what is presented in the first picture below and in some other cases, some modules with grades A- would not be included in the list like what is presented in the second picture below. This is due to the fact that CAP does not only relies to the grades of one semester only but grades of modules in all semesters. The user might be a little bit confused about the criteria.

first picture: All modules with grades below A was S/Ued Screen Shot 2020-11-13 at 5.48.14 PM.png

second picture: CS1010 with a grade of A- was not S/Ued Screen Shot 2020-11-13 at 5.46.50 PM.png


[original: nus-cs2113-AY2021S1/pe-interim#244]

jerroldlam commented 3 years ago

Team's Response

First of all, this might not count as a documentation bug. The screenshot attached is from the tester's own output. In our UG, the inputs from users are green. Hence it is certain the screenshot is not from our UG.

However we will still respond to the documentation side of things. As mentioned within the same output of set su, they shown the best possible CAP when the user decides to SU the semester. What you are seeing is intended, and it is due to the different circumstances of the people as one might be inherently smarter, hence SU-ing the A- is actually a legitimate move for the person as compared to the other.

Futhermore, as stated in the UG, we will just SU from the lowest grade to the highest grade within a semester and produce the corresponding CAP. There is nothing special in this algorithm that requires explanation. Attached is the relevant screenshot from our UG that explains the criteria.

image.png

For these reasons, we will be rejecting this bug.

Duplicate status (if any):

--