search

Ella-e / pe

0 stars 0 forks source link

The name of log file still has "AddressBook" #2

Open Ella-e opened 3 months ago

Ella-e commented 3 months ago

As shown by the screenshot, the application log file created automatically still contains the word address book. It would be better if it is changed to the name of the application, e.g. teacherStack. image.png

nus-se-bot commented 3 months ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Evidences of AddressBook appear in DG's texts

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.

There are a lot of instances of the word "addressbook" appear in the DG's text contents. Since this application is about student management (called TeachStack), it is unlikely for them to use the word AddressBook in the DG.

Here are some of the screenshots, there are others that are not shown: image.png

image.png

image.png

[original: nus-cs2103-AY2324S2/pe-interim#5381] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

Thanks for the suggestion. However, we aim to make the DG consistent with the actual implementation of our code. (Our class is still named addressbook).

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 reason] Name of the log file is not the same bug as the bugs in DG. They are two completely separate things and should be considered separately. For the DG, the team argues that they are following the code implementation. However, for the log filename, this argument doesn't hold, because the log filename is supposed to be the same as the product's name, which is TeachStack.

## :question: Issue response Team chose [`response.Rejected`] - [x] I disagree **Reason for disagreement:** Since the name of your product is TeachStack, developers would feel confused about why the log file is called addressbook because there is nothing to do with "address book" for your product. After using your product and reading the documentation, your product mainly deals with students and managing their grades and contacts, therefore no clues of what is the addressbook. Moreover, the log file is for keeping the logs for the whole product teachStack, not just for some of the classes. In your code repo, the name of the whole product is also changed to teachStack. Therefore, there is no excuse for not changing the name of the log file. ![image.png](https://raw.githubusercontent.com/Ella-e/pe/main/files/204c3572-4516-476f-9835-8b9bc5e0ea46.png)
## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.VeryLow`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]