ivanteejj
commented
4 years ago Team's Response
The team has decided to use the activity diagram to show the work done during the pre-processing step since it provides a very simple and quick overview of what actually happens during the function call.
Suppose that the any of the cases fail, an error will be thrown and the next step will NOT continue. In other words, in order for the rest of the pre-processing step to occur, each stage must pass! The diagram is exactly as the team intended! Moreover, the team has given additional descriptions under the diagram to help potential developers understand the design rationale. As such, since the diagram works exactly as the team intended and we have sufficient explanation in the DG to explain the rationale behind using the activity diagram, this issue is not that important/big.
Duplicate status (if any):
--
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.
In the activity diagram of section 2.2.1, there are 3 fork/join bars, which means either one fork bar does not have a corresponding join bar, or one join bar does not have a corresponding fork bar. Also, the fork-join is not followed as there exists a branching that allow the process to fork and end early without going throughing the join first.
[original: nus-cs2103-AY1920S2/pe-interim#2583]