Pughal77 / pe

0 stars 0 forks source link

Multiple Implementations missing in Developer Guide #8

Open Pughal77 opened 3 months ago

Pughal77 commented 3 months ago

The Developer Guide has multiple of already implemented features such as: 1) adding lesson to the student 2) marking the lesson of a student 3) fee status of the student

Since all of these are crucial operations for the application but are not detailed in the developer guide, this causes a major inconvenience to the user

nus-pe-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]

No Documentation of any commands

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.


It seems as though there is no implementation documentation of any of the new commands given:

image.png

Not sure if its needed, if unneeded then severity is probably "Low" or "Medium".

However, I have no idea how any of the internals work beyond the original AB3 documentation with the DG at the current state.


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

Their Response to the 'Original' Bug

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

No details provided by team.

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 severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** I believe that this is a `severity.Medium` issue. It is important to let the developers reading your DG know of implemented features in the application so that they are able to have a rough idea of the design of features you have added to AB3, making this **your** product. For example for the feature of adding a schedule of lesson to an existing student, you have made the unique design choices such as checking if a lesson is completed or not in `AddLessonCommandParser` (screenshot below) that are different from the implementations of AB3. Developers looking to work on your product will definitely have a tough time understanding the design of your code when there is **no** information on your code. Therefore, I believe this to have a `severity.Medium` as it very often does pose a inconvenience to the user reading the developer guide ![image.png](https://raw.githubusercontent.com/Pughal77/pe/main/files/3ef0b922-022e-4c98-82d1-a8bdcbde0da4.png)