Incorrect class for AddCommand and AddCommandParser method

[rama-pang]

In the Developer Guide, Implementation section, Add Feature section; it is mentioned that "The following methods in Tuthub manage the addition of tutors: Tuthub#AddCommand(Tutor tutor) and Tuthub#AddCommandParser(String args)".

However, in Tuthub.java (https://github.com/AY2223S1-CS2103T-T15-3/tp/blob/master/src/main/java/tuthub/model/Tuthub.java), there is no method called AddCommand or AddCommandParser.

In the Find Feature section, it is also mentioned that "The following methods in Tuthub manage the finding of tutors:"; all following methods are not in Tuthub.java, and is actually referring to objects instead.

[soc-pe-bot]

Team's Response

This is considered a typo.

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

• [x] I disagree

Reason for disagreement: True, it might be considered a typo; but it can cause considerable inconvenience to a developer reading the Developer Guide.

Consider a developer reading the DG, and they read Tuthub#AddCommand(Tutor tutor). What they infer from reading this is that AddCommand is a method in the class Tuthub. Then, directly after reading this, they might check Tuthub.java - only to find out that there is no AddCommand method. The aforementioned developer would need to, check each *.java file one-by-one to find out where is the AddCommand method (only to find out it's not even a method, but a class), or reread the DG to find the correct information about AddCommand.

In general, mistakes are much more damaging compared to not mentioning it in the DG at all. With mistakes (like this bug), the reader will assume that an incorrect thing is actually true, which causes them a lot of inconvenience once they checked the source code only to not find the aforementioned method where they're supposed to be.

As this bug causes inconvenience, it is categorized as severyity.Low.

---