Comments (1)
Team's Response
There are numerous reports that are largely similar and these issues can be identified as subsets of this bug report.
A User Guide is meant to give users a quick taste of the app by guiding them through usage of our commands. The format of each command (including usage of optional parameters) has been written in the UG.
By providing representative examples for actual usage, users can then be more confident in exploring the application for their own use cases. There is very little added benefit and it would not be feasible to include all permutations of examples (especially for different variations of valid input and also optional fields) as it may appear spammy instead. Our approach is to be clear and consise by including an expected outcome for representative examples.
Instead of providing all permutations, we explained under format what are the possible use cases and we believe the examples in User Guides are not meant to be exhaustive.
Items for the Tester to Verify
❓ Issue response
Team chose [response.Rejected
]
- I disagree
Reason for disagreement: Understand the consensus of the team. However, the users may not remember the entire user guide from the start. They may only refer to the section on how to use them. Hence, it will benefit greatly. Given that there's only one optional parameter, it may not be spammy at all to even include one additional line for the optional parameter example.
from pe.
Related Issues (20)
- [Better UI] Long incorrect index message HOT 1
- [User documentation] Does not account for when there's two same prefixes. HOT 1
- Unclear invalid quantity integer message HOT 1
- View feature does not seem useful HOT 1
- Help message for commands may be too long HOT 1
- Better invalid index message for delete HOT 1
- Assigning macro with add command and illegal parameters causes macro cannot be used. HOT 1
- Phone numbers allowed to be 3 digits HOT 1
- Redo does not work after undo is entered twice. HOT 1
- [UG] Command summary does not provide all examples HOT 1
- [UG][Add Supplier Command] Add more examples HOT 1
- [UG][Add Supplier Command] Phone number example can be improved HOT 1
- [UG][Add Warehouse Command] Phone number example can be improved HOT 1
- [UG][Delete Supplier Command] Index information HOT 1
- [UG][Delete Warehouse Command] Index information HOT 1
- [UG][Update command] Clearer tag information HOT 1
- [DG][Autocomplete] Explanation can be clearer for why is it implemented HOT 1
- [DG][Autocomplete] Incorrect examples. HOT 1
- [DG] [Edit command] Edit fields can be more comprehensive. HOT 1
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.
from pe.