Fixes #187: Fix user guide bugs found in PE-D #194
Conversation
| @@ -345,8 +340,11 @@ Parameters Restrictions: | |||
|
|
|||
| * The optional index refers to the index number shown in the displayed person list. The index **must be a positive | |||
| integer** 1, 2, 3, … | |||
| * If the optional index is not provided, all loans, across all clients in the list will be shown. | |||
There was a problem hiding this comment.
Should we say all active loans here?
There was a problem hiding this comment.
I didn't include it because the next line immediately after this talks about the active loans.
There was a problem hiding this comment.
Hmm that is true, but I feel like this could indicate a problematic behaviour in how all loans are distinguished from all loans, including inactive ones in the UG. This is because when we say all loans, it is implicitly implied that they do not include inactive ones, but a user (especially one who has not read anything on all loans, including inactive ones) might misinterpret that to mean the latter.
Regardless, I'll approve these changes first and we could address this issue in a separate PR.
| @@ -430,14 +427,18 @@ Example: `deleteloan 1` | |||
|
|
|||
| ### Analysing a client's loan records: `analytics` | |||
|
|
|||
| Provides visual analytics of a client's loan records. | |||
| Provides visual analytics of a client's loan records based on three indices: Reliability, Impact, and Urgency. | |||
| * The Reliability index is defined as the ratio of overdue loans to the total number of loans. | |||
There was a problem hiding this comment.
Do you think we should give examples here? Some users might be unable to visualise the concept of a ratio without an example.
There was a problem hiding this comment.
I considered this, but I'm worried that it could get pretty cluttered.
There was a problem hiding this comment.
Hmm that is true, perhaps we could add this in another PR.
| @@ -345,8 +340,11 @@ Parameters Restrictions: | |||
|
|
|||
| * The optional index refers to the index number shown in the displayed person list. The index **must be a positive | |||
| integer** 1, 2, 3, … | |||
| * If the optional index is not provided, all loans, across all clients in the list will be shown. | |||
There was a problem hiding this comment.
Hmm that is true, but I feel like this could indicate a problematic behaviour in how all loans are distinguished from all loans, including inactive ones in the UG. This is because when we say all loans, it is implicitly implied that they do not include inactive ones, but a user (especially one who has not read anything on all loans, including inactive ones) might misinterpret that to mean the latter.
Regardless, I'll approve these changes first and we could address this issue in a separate PR.
No description provided.