Open sueann-chua opened 2 years ago
No details provided by team.
[The team marked this bug as a duplicate of the following bug]
Repetition of explanations in implementation segments
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.
Again, repetition of explanations with minor changes for each implementation. Perhaps more unique details for each feature could be given so that the explanations could be more useful and seem less repetitive.
[original: nus-cs2103-AY2122S1/pe-interim#5309] [original labels: severity.VeryLow type.DocumentationBug]
[This is the team's response to the above 'original' bug]
Hi.. again this is a deliberate design consideration that our team has chosen to implement. Although they differ in small ways, the differences are not negligible.
You are right in saying that we should provide unique details for each feature, and that is what we have exactly done. For example,
A unique feature about Accept command is that once an application is accepted, the completion field will automatically change from "Uncompleted" to "Completed".
Another example would be:
Complete models the completion entity which can take on the values "Completed" and "Uncompleted", whereas Accept models the status entity which can take on the values "Pending", "Accepted, "Rejected"
This is something that our team has carefully thought out and we feel that it is important for the reader to capture this information.
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]
Team chose [response.Rejected
]
Reason for disagreement: [replace this with your explanation]
Each feature implementation included the steps which were all rather similar with a few minor changes for the name of the command, which made the DG unnecessarily repetitive.