pe's Introduction
pe's People
pe's Issues
Users should be warned that tags are not allowed to contain whitespace explicitly.
Users should be warned that whitespace is trimmed
test
No details provided by bug reporter.
Large indices throw a different error message
Editing the reminders.json file to have an invalid date does not notify the user
Edit 'reminders.json' to have an invalid date as shown below.
From the UG, "If your changes to the data file makes its format invalid, Rapportbook will discard all data and start with an empty data file at the next run." But it is not at all clear that edits to 'reminders.json' will only invalidate the data for reminders and not for all the data including client data.
Why should the user be notified of any parsing errors in reminders.json, or why should any parsing errors from reminders.json invalidate all data?
Because the user will continue to use the app as expected. If there are many reminders, and if just one of them has an invalid date but is a really important reminder, the user will not realise that this important reminder is missing.
Incorrect data file name in UG
The section on "Implementation" in the DG is confusing
"Implementation
This section describes some noteworthy details on how certain features are implemented.
UI Design
Proposed Implementation"
The above is taken from the DG.
But this is confusing, as the "UI Design" talks about three things: desired endstate of the UI, proposed alternatives, and the current choice.
Instead of mentioning all 3 under "Proposed Implementation", a separate subsection called "Current Implementation" should be created to talk about the current choice. Then another subsection called "Alternatives considered" can talk about the other alternatives considered. Then "Proposed Implementation" should only talk about the desired endstate - the use of Material Design.
This will help reduce confusion on what is implemented, what are the alternatives possible, and what is the ideal implementation.
Help window is not displayed at all
To reproduce, simply type help
or press the 'Help' button.
In either case, on my computer, the Help window does not show up at all. Please view the screenshot and the screen recording for details.
Details of my set-up:
Linux parth 5.15.0-52-generic #58-Ubuntu SMP Thu Oct 13 08:03:55 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
video:https://raw.githubusercontent.com/parth-io/pe/main/files/13e2edeb-8678-49e9-9dab-1acdc20dd68f.mp4
Date parsing silently allows invalid dates to be parsed
Empty arguments for parameters should be disallowed
Steps to reproduce:
- Type
add n=Laufey p=98980184 [email protected] a=123,Clementi r=
The parameter r=
has no arguments, yet it is accepted. It is prudent to warn the user or throw an error message that this is meaningless input, and get the user to either remove the r=
or add the remark.
Overuse of class diagrams in DG
Class diagrams are overused and hamper readability.
For example, for the "Show Command", it is not really clear why the inclusion of this class diagram is useful to the reader. The class diagram is not directly referenced in the description and is just left for the reader to read through without any full understanding of its significance. Furthermore, it does not even seem significant or useful, as I can just read the code to understand what methods are implemented.
Too many use cases
Similar use cases such as create tag and delete tag.
Delete tag should reference create tag for clarity to reduce duplication.
The UG does not mention what is valid syntax for client, reminders, and tags
Some context about the acceptable syntax should be provided in the UG.
For example, the requirement for clients' names is "Names should only contain alphanumeric characters and spaces, and it should not be blank" from the app itself.
But this is not stated in the UG
Data storage file does not invalidate incorrect tag names
Section on process requirements is unnecessary, specific deadlines are not required
Too many images for tag and message delete
There are too many images in the UG for the tag
commands. Each message shows a lot of detail about the other clients which is unnecessary and hampers the ability of the reader to scroll quickly in the UG.
What can be done better:
Each tag command has a different success message - perhaps just this message itself can be replicated in the UG instead of a screenshot of the entire UI.
For commands like tag remove 3 bff
, the UI does get updated in such commands. But as we cannot see the previous UI, showing the updated UI for any comparisons is meaningless. Furthermore, the UI has details of other clients. It's best to just display the success message only in the UG.
Error message is incorrect if the tag index is incorrect
T
s
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.