search

nus-cs2103-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Minor inconsistency in implementation section of undo/redo feature in DG #5690

Open nus-se-bot opened 2 years ago

nus-se-bot commented 2 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.

All the features along with the implementation generally follow the format :

Name of feature

[Short description]

Implementation

[Implementation details]

For the undo/redo feature however, the short description following the name of the feature is missing.

[original: nus-cs2103-AY2122S1/pe-interim#5717] [original labels: severity.VeryLow type.DocumentationBug]

Wilfredwongkc commented 2 years ago

Team's Response

Thanks for the issue. We do not consider this as a bug because there is no requirement to follow a specific format in the Implementation section and actually we were not following a specific format either. The implementers for different features have their own considerations when documenting the noteworthy details in the Implementation section, and we think it is not noteworthy to include a short description for “undo/redo” feature

Duplicate status (if any):

--