ped's People
ped's Issues
Product screenshot differs between UG and JAR
The UG does not currently reflect the current product. Perhaps it would be better to ensure that the UG reflects the latest version of the product release, rather than to state "to update".
Steps to reproduce
java -jar tahelper.jar
Product Screenshot in UG (Actual)
Product Screenshot when executing JAR
file (Expected)
Absence of a add_module command
Based on the UG, there is a delete_module
command as shown below:
However, there is no add_module
command in the UG as such it was slightly unclear how a user can add a module in the product. Instead, a module can be added using the add_class
command as shown below:
Perhaps it would be better to emphsise in the command description that the add_class
command also adds a module to the product if it does not exist.
Another suggestion would be to separate the addition of class and module to improve clarity, since the commands for class and module deletion are separated into delete_class
and delete_module
respectively.
Missing symbol definition in Command Format
In the Command summary table, the symbols <
and >
are used, however these symbols are not explained in the Command Format section.
Command summary example
Command Format table
Perhaps it would be better to include an entry in the Command Format table like:
Symbol: <>
| Example: <name/, id/, email/>
| Description: only one parameter of name/
, /id
, or email/
should be supplied.
Wrong command in Delete module action in command summary table
Mismatch in parameter name for add_student_to_class command
In the UG, the follow command format is stated for the add_student_to_class
command: /add_student_to_class [id/STUDENTID] [index/INDEX] [email/EMAIL] module/MODULE_CODE class/TUTORIAL_CLASS
.
The class
parameter should be changed to tutorial
, as entering class
will result in an invalid command format.
Steps to reproduce
/add_student name/Dohn Joe id/A0123456A email/[email protected] tag/Helper
/add_student_to_class id/A0123456A module/CS2109S class/T01
Expected
Actual
Case sensitivity not specified for MODULE values
In the UG, the constraints stated for MODULE
values are as follows: "Follows the format of NUS CS modules, which starts with either 2 or 3 alphabetical letters, followed by 4 numeric integer between 0-9, and an optional alphabetical letter."
When trying to delete to an existing module using delete_module
, a value of lower case will return an error instead of deleting the module.
Suggested fix
Perhaps, it would be better to specify that MODULE
values are case-sensitive alphabetical letters.
Steps to reproduce
/add_class module/CS2109S tutorial/T01 description/Introduction to AI size/10
/delete_module module/cs2109s
Expected
Actual
Example in Command summary does not work for Add New Students
The given example for Add New Students is: /add_student name/Dohn Joe id/A0123456A email/[email protected] id/A0123456A
When executing the command on the JAR. it results in an error due to the duplicate /id
fields.
Wrong command in Sort students action in command summary table
search_student runs successfully for an invalid command format
The search_student
command format stated in the UG is: /search_student [id/STUDENT_ID] [email/EMAIL] [name/NAME]
This means that a user should not be able to add any text before the search query in the command. However, the command runs successfully in this instance.
Steps to reproduce
/add_student name/Dohn Joe id/A0123456A email/[email protected]
/search_student Dohn Joe name/Dohn
Suggested fix
Perhaps it would be better to show an invalid command format error message in this case.
Mismatch in parameter name for add_class command
In the add_class
section of the UG, the following format is specified: /add_class module/MODULE_CODE class/TUTORIAL_CLASS [description/DESC] [size/SIZE]
.
The class parameter appears to be invalid as when executing the example command given below in the section, the product displays an error message that says that the command format is invalid.
Suggested Fix
The fix would be to update the class/
parameter to tutorial/
as stated in the error message
Steps to reproduce
/add_class module/CS2109S class/T01 description/Introduction to AI size/10
Expected
Actual
Typo in command format for class_list_students example in Command summary table
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.