Giter VIP home page Giter VIP logo

pe's People

Contributors

praveenelango avatar

Watchers

 avatar

pe's Issues

DG Bug: Insufficient visuals used to explain `Logic` component

A UML class diagram was used to explain the Logic component of the app.

Screenshot 2020-11-13 at 5.40.25 PM.png

The steps of the Logic component were explained step-by-step in the DG as follows:

Screenshot 2020-11-13 at 5.38.56 PM.png

However, it can be seen that if-else statements were used to explain the steps of the Logic component. For this paticular case, the use of a sequence diagram may have been more appropriate in explaining the steps which could have been included in addition to the class diagram. Including all the steps in text documentation format may be confusing to the developer as opposed to a sequence diagram.

Cannot navigate to entry tracker

When I tried using the UG command to access the entry tracker by typing in entry, it returned invalid command.
Screenshot 2020-11-13 at 5.00.28 PM.png

I then observed in the UG that the entry tracker was attempted to be accessed from inside the manual tracker (which was not specified - the UG mentioned that it has to be accessed from main commands).
Screenshot 2020-11-13 at 4.59.43 PM.png

I was not told how to do this but when I attempted to type entry inside manual tracker, it also gave error.

Screenshot 2020-11-13 at 5.00.16 PM.png

DG: Overly complicated sequence diagram to show `AccountStorage`

An overly complicated sequence diagram is used to show AccountStorage, paticularly in the alt block wehre the sequeunce of events is the same for most of the cases. This could be simplified when being shown in the diagram since it is now rather repetitive.

Screenshot 2020-11-13 at 5.56.15 PM.png

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.