kennethszj / pe

0 stars 0 forks source link

discrepancy between actual saved json and documented json #5

Open kennethszj opened 1 week ago

kennethszj commented 1 week ago

in the documentation, it states json file should follow the following format

image.png

however, the json saved by the program after inputting data is as follows

image.png

soc-pe-bot commented 3 days ago

Team's Response

Thanks for raising this issue. Tester seem to misunderstood the 2 files that are being compared. The purpose and usage of the 2 files is entirely different. The file on the bottom is after the user has finished running the allocation algorithm and data is saved to an external file in the mentioned format. The file on the top is the format that the user should stick to when uploading data of a large batch of students as clearly stated in the UG. Tester seem to stick with the idea of iP where data generated through the program will be saved and allowed to be pass through the program again (Closed Loop System). However, as mentioned at the start of the UG under Pre-Usage Guidelines, the allocation results file is not meant to be re-inputted into the program. The program is design to have one input and one output where the output cannot be used as input (Open Loop System).

image.png

image.png

image.png

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

discrepancy between saved csv file and documented example

below is the format the csv file is saved

image.png

below is the documented example of how csv file is saved

image.png


[original: nus-cs2113-AY2425S1/pe-interim#630] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Thanks for raising this issue. Tester seem to misunderstood the 2 files that are being compared. The purpose and usage of the 2 files is entirely different. The file on the top is after the user has finished running the allocation algorithm and data is saved to an external file in the mentioned format. The file on the bottom is the format that the user should stick to when uploading data of a large batch of students as clearly stated in the UG. Tester seem to stick with the idea of iP where data generated through the program will be saved and allowed to be pass through the program again (Closed Loop System) so the output should be the same as input. However, as mentioned at the start of the UG under Pre-Usage Guidelines, the allocation results file is not meant to be re-inputted into the program. The program is design to have one input and one output where the output cannot be used as input (Open Loop System).

image.png

image.png

image.png

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]


## :question: Issue response Team chose [`response.Rejected`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]