Giter Club home page Giter Club logo

ped's People

Contributors

tyuyang avatar

Watchers

 avatar

ped's Issues

Program crash when search function cannot find matching arguments

This bug applies to the following commands:

  1. remove-pet
  2. remove-stat

Will this count as 2 bug? :)

When the user enters a NAME that is not part of the existing pet list, the program will sometimes crash, and sometimes show the ERROR: Pet not found error message. I could not find a pattern for those crashes though.

No list of STATs

In the adding a stat to a pet section of the user guide, there are no examples of what are considered valid stats, so the user can assume that any random string can be entered for the STAT parameter.

image.png

App commands are space sensitive

image.png
Example above is when I used the add-pet command for the NAME " hihi" rather than "hihi"

Doing the commands: ("" added to show the spaces, commands are performed without the "")

  1. add-pet "hihi "
  2. remove-pet "hihi "

Will crash the program, which further shows that it is space sensitive.

Any string can be inputted into stat

image.png

The program should check if input is valid number for the stats age and weight since only numbers should be expected as input for those stats.

No exit feature in UG

In the user guide, there is no exit feature. The only way to exit the program is to close the whole terminal? I assume that this is just missing documentation since typing exit in the terminal actually exits the application.

image.png

NAME parameter not specific

image.png
For the adding a pet feature, the NAME parameter is ambiguous since it could also refer to the name of the owner rather than the name of the pet. Recommended to specify in the user guide that the name refers to the name of the pet.

Logging messages not hidden from user

Logging messages are shown when using the application. Example when I typed the command exit below.

image.png

As a user, one should expect that trivial logging messages like those should be tagged under FINE to FINEST rather than INFO.

Grammatical errors in UG

In the removing a pet section of the user guide, the description of that section has grammatical errors. "Removes a pet to the Pet List" should be "Removes a pet from the Pet List" instead.
image.png

Ambiguity in meaning of parameter NUMBER

From removing a task section to marking a task as not done section, the parameter NUMBER was never clarified to mean task number, which can be unclear for the user. None of the expected output examples showed any relationship between the NUMBER and the task number either.

In addition, the user will not be able to tell if the NUMBER parameter refers to the number as seen in the list-task or schedule command.

Grammatical inconsistencies

In the viewing pet list section, the first word view is in plural form, which is grammatically inconsistent with the rest of the user guide. It should be views instead.

image.png

Quick start guide incomplete

image.png

In quick start of the user guide, step 3 is missing the instruction to cd into the directory that the pettracker.jar file is in. Running the stated command without changing the directory results in this:

image.png

Omitting the part where I type the command out for privacy reasons. Just trust that I did what I said.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.