search

naranghardik16 / pe

0 stars 0 forks source link

Glossary #8

Open naranghardik16 opened 3 years ago

naranghardik16 commented 3 years ago

Suggestion: Can add few keywords under glossary like the keyword 'index'. This will help the user to understand the term 'index' better. 'index' has been used in more than one command so mentioning it again and again that it should be a positive integer can be avoided.

in the glossary it can be mentioned as index: the position of a contact in the list. it starts from 1.

Screenshot 2021-11-12 at 5.36.19 PM.png Screenshot 2021-11-12 at 5.36.08 PM.png

nus-pe-bot commented 3 years ago

Team's Response

Thank you for your suggestion. We will take that into consideration 😊.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: The documentation bug which I have stated should have been accepted as the term index has been used in a number of places throughout the UG. This term is not clear to the common user and they can easily confuse it with the term position. The term index always starts from 0 but position can never start from 0. The team has described the term index again and again which is why I feel that it should definitely be put in the glossary to increase the user readability.