search

alexgoexercise / pe

0 stars 0 forks source link

Inconsistency in the UI design about the use of lines #2

Open alexgoexercise opened 1 year ago

alexgoexercise commented 1 year ago

image.png

image.png As you can see from here, there is an inconsistent use of the lines(some segments do not have lines before user inputs a value, some segments have double lines before the next user input etc.) This can be potentially confusing to the user, however, it does not really affect the normal use of the programme and thus the severity would be very low.

nus-se-script commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Lengths of separator lines are not equal

steps to reproduce

enter 'Help'

expected

Hello! Welcome to the Help Manual for BadMaths!

  1. Type -> Graph [equation] <- to perform graph calculations
  2. Type -> Matrix [equation] <- to perform matrix calculations
  3. Type -> Store [any_string] <- to add notes
  4. Type -> List <- to list all stored notes
  5. Type -> List [index] <- to display a particular note
  6. Type -> Delete [index] <- to delete a particular note
  7. Type -> Clear <- to delete all stored notes
  8. Type -> Mark [index] <- to mark a particular note as completed
  9. Type -> Unmark [index] <- to unmark a particular note as incomplete
  10. Type -> FindMark <- to display a list of all notes marked as completed
  11. Type -> FindUnmark <- to display a list of all notes marked as incomplete
  12. Type -> FindInfo <- to find items stored in Notes through searching for a keyword
  13. Type -> [Priority] [index] <- to change the priority of a note
  14. Type -> Rank Priority <- to display all notes of all priority rankings
  15. Type -> Rank Review Count <- to display all notes ranked by review count
  16. Type -> FindPrior [Priority] <- to display all notes of a certain priority
  17. Type -> Quadratic [equation] <- to perform quadratic calculations
  18. Type -> History <- to display a list of command history
  19. Type -> Help <- to display content of Help Manual
  20. Type -> Bye <- to exit program

Thank you for using BadMaths. We hope that BadMaths will be a useful study tool in helping you to perform Mathematical Operations. For more details, please visit our GitHub website [https://github.com/AY2223S2-CS2113-F10-2/tp]. If you have any queries on BadMaths, please contact [wilsonleejunwei@u.nus.edu].

actual

Help

Hello! Welcome to the Help Manual for BadMaths!

  1. Type -> Graph [equation] <- to perform graph calculations
  2. Type -> Matrix [equation] <- to perform matrix calculations
  3. Type -> Store [any_string] <- to add notes
  4. Type -> List <- to list all stored notes
  5. Type -> List [index] <- to display a particular note
  6. Type -> Delete [index] <- to delete a particular note
  7. Type -> Clear <- to delete all stored notes
  8. Type -> Mark [index] <- to mark a particular note as completed
  9. Type -> Unmark [index] <- to unmark a particular note as incomplete
  10. Type -> FindMark <- to display a list of all notes marked as completed
  11. Type -> FindUnmark <- to display a list of all notes marked as incomplete
  12. Type -> FindInfo <- to find items stored in Notes through searching for a keyword
  13. Type -> [Priority] [index] <- to change the priority of a note
  14. Type -> Rank Priority <- to display all notes of all priority rankings
  15. Type -> Rank Review Count <- to display all notes ranked by review count
  16. Type -> FindPrior [Priority] <- to display all notes of a certain priority
  17. Type -> Quadratic [equation] <- to perform quadratic calculations
  18. Type -> History <- to display a list of command history
  19. Type -> Help <- to display content of Help Manual
  20. Type -> Bye <- to exit program

Thank you for using BadMaths. We hope that BadMaths will be a useful study tool in helping you to perform Mathematical Operations. For more details, please visit our GitHub website [https://github.com/AY2223S2-CS2113-F10-2/tp]. If you have any queries on BadMaths, please contact [wilsonleejunwei@u.nus.edu].

screenshots

image.png

[original: nus-cs2113-AY2223S2/pe-interim#27] [original labels: severity.VeryLow type.FunctionalityBug]

Their Response to the 'Original' Bug

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

Thanks for feedback regarding the help command of BadMaths. As a developer, I would like to clarify that the function of the help command is to display the help manual stored in the corresponding text file, which it does successfully. The content displayed by the help command matches the content stored inside the file, which indicates that the function is working correctly.

Regarding your concern about the different lengths of line separators, please note that this is not a bug. The variation in the length of the line separators is intentional, as it is intended to assist the user in reading the manual and improve the overall aesthetic of the text. Therefore, it should not be considered a bug or an issue with the help command.

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: The bug I have reported is of a different problem;

The normal practice is to use a horizontal line to differentiate between the machine input and user input, which is demonstrated by the other sections of your product as well.

However, if you notice that at the beginning of the programme (after the logo is shown), there is no horizontal line given and it seems like it's still not the chance for user to type in any command yet.

## :question: Issue response Team chose [`response.Rejected`] - [x] I disagree **Reason for disagreement:** The bug I have reported is of a different problem; The normal practice is to use a horizontal line to differentiate between the machine input and user input, which is demonstrated by the other sections of your product as well. However, if you notice that at the beginning of the programme (after the logo is shown), there is no horizontal line given and it seems like it's still not the chance for user to type in any command yet.