Code Monkey home page Code Monkey logo

pe's People

Contributors

oasisbeatle avatar

Watchers

 avatar

pe's Issues

Error Message Formatting [DG]

The error message for all the commands in the command list section could be indicated by a WARNING or ERROR icon, it looks a little better in that format rather than a bullet point.

Screenshot 2020-11-13 at 5.51.15 PM.png

No Validation for Spend Command Currency Parameter

The spend command takes in any value of currency. To reproduce enter spend lunch v/5 date/2020-11-08 currency/monkey as shown:

Screenshot 2020-11-13 at 4.43.24 PM.png

Possible improvement to the feature could be to validate what currency is entered.

General Formatting Issues With the Developer Guide [DG]

  1. The page numbers could be included for easier navigatability and reference while bugs are being checked.

  2. Bolding the unfamiliar keyword could be done so the user can know to reference the acronym mentioned. Also a hyperlink to the glossary of terms would be quite helpful! Could be done with the keywords "DRY" and "SLOC" as shown below:

Screenshot 2020-11-13 at 5.57.25 PM.png

Formatting of Storage Feature Sequence Diagram [DG]

The sequence diagram for storage is quite large and hence it breaks across the page. Maybe you could abstract the diagram a little more or create seperate diagrams to show one or two interactions of storage with the commands.

Screenshot 2020-11-13 at 5.43.02 PM.png

Class Diagram for Command Component [DG]

  • The purpose of the diagram below is slightly unclear as it is not labelled with the title of the diagram.
  • The connection between the enumeration classes and the command classes could be indicated to clarify which commands access the enumeration class while executing.
  • I believe the arrow that indicates inheritance could be a bit larger as the arrows right now look kind of like connecting arrows.
  • Maybe the size of the diagram could be made larger for easy viewing
  • I think that an architechture diagram could have been a little bit better to represent the various commands rather than a UML diagram as there is less complexity involved

Screenshot 2020-11-13 at 5.31.47 PM.png

Command Descriptions [DG]

I believe the description of the commands could be shortened in the list feature section and replaced with sequence diagrams to make it a little bit clearer

Screenshot 2020-11-13 at 5.47.31 PM.png

Spend Command Currency Parameter accepts zero value

The spend command allows to set a spending task to 0, which is not techincally an expense as it has no value. To reproduce the bug type in spend lunch v/0 date/2020-11-08 currency/SGD as shown:

Screenshot 2020-11-13 at 4.46.16 PM.png

To improve this bug, the value of zero price could be rejected by the function.

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.