Git Product home page Git Product logo

pe's Introduction

Hi there ๐Ÿ‘‹, I'm Ryan Loh

GitHub followers

Started learning about programming during my National Service and love exploring new opportunities and technologies in my free time!

My Projects

GitHub Stats

Stats

Contact Me

Feel free to reach out to me if you need any assistance or just want to chat about coding.

pe's People

Contributors

ryanlohyr avatar

Watchers

 avatar

pe's Issues

Developer Guide sequence diagrams are extremely clunky and impossible to read

Image 17-11-23 at 5.18 PM.jpg

Most if not all sequence diagrams provided in the UG are almost one page long. Which makes it hard to read for the developer reading it.

We can use ref to seperate them, for example for the goal feature, we can use one ref for goal /add and goal /remove rather then adding both into one extremity large sequence diagram.

As the goal of the developer guide is to allow the developers to understand the flow of the features within the codebase, which was not achieved due to the lengthiness of the sequqnece diagram, I have rated this bug as high.

Not really sure why the export function is necessary

Image 17-11-23 at 4.45 PM.jpg

Currently, all transaction are already stored and updated in the data folder under income-store and expense-store. Hence could a Transaction-store be already created under the data folder? Why must there be a 'seperate' feature just for transactions

Invalid Example in User Guide

User guide examples should be valid and used in the application, which definitely includes newlines.
Image 17-11-23 at 4.33 PM.jpg
In Image above, the example in the user guide includes a newline. Which returns invalid in the application shown below.
Image 17-11-23 at 4.33 PM.jpg

UserGuide- Inconsistency in Command summary

Image 17-11-23 at 5.35 PM.jpg

In the application, text related arguments are all lowercased. Hence its not very clear why in the example above(command summary) we use a lower case ps5 in edit and a uppercase ps5 in adding of a goal.

Unclear error message

Image 17-11-23 at 4.17 PM.jpg

The correct code is suppose to be
delete 1 /type in. However when I type in
delete 1 in, it says above, Please enter a valid index. Which is a misleading error message as the argument '/type' is missing rather than there being a invalid index

Unclear feature

Image 17-11-23 at 5.05 PM.jpg

Not really clear what unused goals means? Not stated in the user guide as well. In my opinion if the developers come up with their own terms, it should be explained clearly to beginner users using the application for the first time.

Unclear initialisation command

Image 17-11-23 at 4.10 PM.jpg

The command for initialisation is unclear, am I suppose to type in my name or my command?
Should be more explicitly stated at the start

User guide: examples not clearly labelled

Image 17-11-23 at 5.25 PM.jpg

I think for examples as shown above, e.g out dinner /amount 10.50 /category food. We can write it as

Example: out dinner /amount 10.50 /category food. When the reader reads the user guide, it can clearly see which is the example and which is the explanation

Confusing error message regarding to goal

Error messages should be clear and intuitive to the user.
Image 17-11-23 at 4.41 PM.jpg

The error message above is unclear, and can definitely be more specific. For example 'you have entered a goal that does not exist yet.' As invalid goal can mean invalid characters, doesnt exist etc....

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.