Git Product home page Git Product logo

pe's Issues

Formatting of sentences not consistent in developer guide

Just a nit, some parts do not use ':' after certain phrases like 'Alternative 1' to separate from the contents afterwards while some parts do. As seen in the image below, figure 1 does not use ':' while figure 2 does. I think figure 2 is the better choice as it improves readability with the bold too.

Figure 1

image.png

Figure 2

image.png

Valid name with 'S/O' and 'D/O' are not allowed.

The targeted user could have names that contains 'S/O' and 'D/O' but the app does not allow the name to be entered. Perhaps could allow for this specific characters to enable user with said names to use the app.

image.png

'CS2103_TP' given as valid project name in the user guide

Just discovered that the 'CS2103_TP' is widely given (about 18 instances found using ctrl-f in the user guide pdf) as the project name throughout the user guide which will hinder the users' usage as the app only allows alphanumerics as input.

Deadline is allowed to be set in the past

What: The app allows past deadline to be set to the tasks which might cause user confusion if they set a passed deadline and did not realise. As seen in the image below, Feb 10 2024 is back in the past but it is allowed.

How:

  1. Ensure project 'test' and task 'dummy' has been created
  2. Enter set deadline Feb 10 2024 /to dummy /in test

image.png

Project name being case sensitive

The user guide did not state that the project name is case sensitive when supplied to commands like add person /to <PROJECT_NAME>.
The command does not work if the project is 'Emoji' but my input is 'emoji' instead.

Link to the wrong project file

The Logic.java as seen in screenshot in developer guide has the old link which leads to AB-3 repository instead of AY2324S2-CS2103T-W08-4 repository.

Similarly, Storage.java and Model.java too.

image.png

Developer guide not well formatted

The contents in developer guide are separated to next page unexpectedly, hindering readability. Perhaps consider, using page breaks if a section of contents get cut-off

image.png

User guide not well-formatted

The user guide as sections where the contents are unexpectedly cut off to the next page, which might hinder readability. Perhaps have page breaks to move to a new page for each comand if it is cut off.

image.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.