wui-hong
commented
10 months ago Team's Response
We are rejecting this as we believe that the current steps and example given are clear enough to be understood by a university student. We agree that using diagrams could have been better, but we still believe that the textual explanation that we provided can be understood by a university student. Additionally, the meaning of weight in this context is in the glossary.
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.
The 'updatePortion' command allows to update the weights of the payers within a transaction. The feature is good but the documentation for it in the UG is very poor, specially the examples part. It is a relatively complex concept, and should've been illustrated using diagrams or actual lists and proportions. Keeping in mind that the target users of the application are University Students, not all of them are mathematical geniuses, or even study quantitative disciplines and keeping track of weights and understanding the meaning can be quite hard. The UG should include full-length examples of adding/maintaining/editing a transaction, and how it changes the balances, proportions and more. Current way of laying out discrete examples is poor and doesn't enable user to understand the command and its functions properly.
[original: nus-cs2103-AY2324S1/pe-interim#5612] [original labels: severity.Low type.DocumentationBug]