BenedictChannn / pe

0 stars 0 forks source link

Inconsistency in Income and Expense DG #14

Open BenedictChannn opened 8 months ago

BenedictChannn commented 8 months ago

The DG for the income and expense are written by two different people and the steps/way it was written differs a lot in style/ standards. Would be good to standardise since they both are transaction types

nus-se-script commented 8 months ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Sequence diagrams for income and expenses entirely different format

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.


Barring the extra category and type fields for expenses, the sequence diagrams for both income and expenses are completely not standardised at all. For example, expense sequence diagram includes the check on the currency but the income sequence diagram does not have any of that. From a developer point of view, it can be very confusing since naturally we would think income and expense to behave similarly!


[original: nus-cs2113-AY2324S1/pe-interim#294] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

No details provided by team.

Items for the Tester to Verify

:question: Issue duplicate status

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]


## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.VeryLow`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]