search

000verflow / pe

0 stars 0 forks source link

Some commands have no documentation on implementation in DG #16

Open 000verflow opened 11 months ago

000verflow commented 11 months ago

Unable to find diagrams or implementation details on commands like "Edit" does not have implementation details for it.

nus-se-bot commented 11 months ago

Team's Response

As a group, we have decided to add in the main bulk of the commands into the developers guide where the main functions such as “find” “add” “delete” etc are the ones that are more important to provide implementation details on. Whereas for smaller/minute features like “edit” is not added. But we have still addressed on how this feature should be inputted.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: I believe all functionality need to be documented, be it smaller or minute features as that's the purpose of the implementation section in the DG. Moreover, edit feature implementation should be documented, so the advanced users know how to tweak it to their liking.