pe's People
pe's Issues
Entering Ctrl + Z sends the command in an indefinite loop
DG - No guide on how to set up the project for development
As a new developer, without this section, I am unsure of how to begin developing for this application.
DG - Errata in 'Saving data' sequence diagram
Modifying reservations in the text file allows me to put in a 'pax' value that exceeds the package vacancy
I have the following package (note the vacancy total of 30):
with the following reservation info:
If I were to quit the app, open the data.txt file and modify the vacancy for the second reservation to a number larger than the permissible vacancy limit:
The application launches fine and the new 'pax' value for reservation 2 is displayed without issue:
Discrepancy between package vacancy and reservations made
Commands can be potentially confusing and misleading
I noted that the commands to create and view information about a package are 'add' and 'info'/'all' respectively. However, I feel that this can be potentially confusing for users as these command words (i.e. 'add', 'info', 'all') do not indicate that these commands are specifically meant for handling packages. For example, as an end-user, when I see the word 'add', I thought this command could perhaps be used to add either a package or a reservation.
As a suggestion, perhaps the 'add' command could've been renamed to 'addPackage'? That way the ambiguity is reduced.
DG - 'Feature - Parser' sequence diagram is 'chopped off'
UG - `info` command could have more descriptions
This is the description for the info
command:
This is an example of my usage of the info
command:
Perhaps the formatting of the date in the info
command could be described in the UG? That is, is it yyyy-dd-mm
or yyyy-mm-dd
?
This can be useful because the add
command requires me to format the date in dd-mm-yyyy
. Thus, the difference in the way the date is displayed can be potentially confusing for a new user.
UG - Insufficient description of `add` command parameters
In particular, perhaps the {vacancies}
parameter could have a description to describe what kind of vacancy.
As a new user, I was a bit confused when I saw that {vacancies}
parameter without any description of it.
'help' command does not show how to exit the application
UG - No information on how to exit the application
I had to cycle through the common exit keywords 'exit', 'quit', before getting the right keyword ('bye').
As a new user, this can be a minor inconvenience for me.
UG - `reserve` command could have listed the duplicate constraint
Modifying text file to have same reservation and contact number will load the data in normally
I have the current reservation information for package ID 12345:
I understand that you cannot add a new reservation with the same package ID and contact number, as shown in the screenshot below:
However, if I were to quit the application and edit the second reservation (Bad Boy123, 111111111111111) in the text file to have the same contact number as my first reservation for package ID 12345:
The file loads just fine and the reservations are displayed fine:
I believe that this is a discrepancy as the application does not allow me to add a new reservation that has the same package ID and contact number as an existing reservation.
Adding a new reservation to a package with more pax than vacancy is permitted (but it shouldn't be?)
DG - Instructions for manual testing feels unclear
The 'Instructions for manual testing' section feels unclear. For example, please refer to the 'Test Case 1':
Some considerations:
- Perhaps the header 'Test Case 1' could be more descriptive of what the test case is about?
- The test case mentions using the
package
command to view all available packages. However, as a developer who recently just set up the app and just wanted to test it out, it would be helpful to list down the steps to create the packages as shown in the screenshots.
Displaying packages by sorting order should show more information
Currently, if I were to use the 'all' command to sort the packages, I would get the following:
However, as an end-user, I find this potentially inconvenient that the values that I'm sorting the packages by are not displayed on the list. WIthout the values, I cannot make proper comparisons between the packages when viewing them in the list.
For example, if I wanted to sort by price, it would be better if I could also see the prices of each package in the list. Likewise, if I were to sort by date, it would be nice to see the dates in the list instead.
Possible use case: A customer wants me to find them a package that is within a certain price range. It would be useful if I can sort the packages by price and see which packages fall within that range by scanning their prices on the list.
DG - Errata in 'Initialisation (Loading Data)'s sequence diagram
Some issues regarding the object creation of Storage
object in the sequence diagram:
- For the constructor method call
storage(filePath)
, the 's' instorage
should be capitalised. - Missing activation bar for object creation of
Storage
- Missing return arrow after creating a
Storage
object.
Other issues:
- The
parseTravelpackageFile
andparseReservationFile
methods are missing their parentheses.
Dummy bug report
This is a dummy bug report
EDIT: fix typo error
UG - The flow of the introduction to the commands feels unusual
In the UG, I noted that the package-related commands are introduced in the following manner: packages > info > all > add > delete.
However, I feel that the 'add' command should be placed before the 'packages', 'info', and 'all' commands.
As a new user of the app, showing me how to view the packages when I do not know how to create them yet doesn't feel right.
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google โค๏ธ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.