Comments (1)
Team's Response
No details provided by team.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Complexity of sequence diagrams in DG
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.
Some diagrams in the DG like the one shown above are rather large. Perhaps the usage of ref frames as seen here would help breaking down complex diagrams if stuff like certain method calls have to be shown.
Another instance of sequence diagram with a lot of self invocations which makes the diagram very long:
Once again the use of ref frames could be considered to improve readability.
[original: nus-cs2113-AY2122S1/pe-interim#2049] [original labels: severity.Medium type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
We believe that the first diagram is fine as it is. Enough detail must be given for a diagram to serve its proper purpose. We do agree though that the second diagram is a little too long and could be broken down into smaller parts.
Items for the Tester to Verify
❓ Issue duplicate status
Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)
- I disagree
Reason for disagreement: The original issue was talking about the design of your sequence diagrams, not about the extra headers that I was talking about in my issue. Clearly I'm talking about a different bug.
❓ Issue severity
Team chose [severity.VeryLow
]
Originally [severity.Low
]
- I disagree
Reason for disagreement: [replace this with your explanation]
from pe.
Related Issues (20)
- Entering empty description causes amount to be recognized as both amount and description for `add_ex` HOT 1
- Entering empty description causes amount to be recognized as both amount and description for `add_in` HOT 1
- Missing `d` and a space in the example for `add_in_d` HOT 1
- Not adhering to date format causes program crash for `btw_ex` HOT 1
- Extra parameters lead to date entered for `find` command not being recognized HOT 1
- KEYWORD for `find` command allows for non-alphanumeric inputs HOT 1
- `find` performs search on fields aside from the description or category of item
- Case-sensitivity of category for `check_budget` HOT 1
- Specifying a parameter multiple times for `check_budget` causes it to give invalid argument exception HOT 1
- Specifying a parameter multiple times for `set_threshold` causes it to give invalid argument exception HOT 1
- Specifying the currency parameter multiple times results in invalid currency error HOT 1
- Unlinked `Features` word in UG Quick Start HOT 1
- Class diagram of `FinancialTracker` component too complex HOT 1
- Missing return type for `setCurrentTest` HOT 1
- Return type of a getter method `getCurrency` is void? HOT 1
- Wrong return arrow head for `expenseCategoryToBudget` in Budget Component sequence diagram HOT 1
- Long sequence diagram of Graphic component is not readable HOT 1
- Inclusion of library classes as part of class diagram for Data Storage Component HOT 1
- Missing data type of currency for `setCurrency()` HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pe.