nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Bolt command section does not say how to unbolt #2965

Open nus-pe-bot opened 6 months ago

nus-pe-bot commented 6 months ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.


Documentation Bug Description

A reader who is viewing the bolt command won't know how to lower bolt count:

image.png

This question is NEVER DIRECTLY ANSWERED (note even in the FAQ).

image.png

Expected

Some tip in the bold command section of how this can be changed.

Severity

severity.Medium : A flaw that causes occasional inconvenience to some users, but they can continue to use the product.

Not a purely cosmetic issue in docs or UI, since it affects readability, so cannot be VeryLow. As a user, one might be very bewildered because you would need to have read the edit section, realised that there is no way to "unbolt" and then realise that you can do this using edit, without it ever been told to you. In my mind, this is inconvenient enough to warrant a Medium.


[original: nus-cs2103-AY2324S2/pe-interim#3732] [original labels: severity.Medium type.DocumentationBug]

chiaryan commented 6 months ago

Team's Response

Hello, thanks for bringing this inconsistency to our attention. However we don't think that the consequence is as dire as reported.

  1. Regarding the FAQ on the star command, although bolts are not mention, it would not be too far-fetched to suggest that the reader would also assume that the edit also works on bolts.
  2. We are assuming that the reader has read the entire documentation and would know what the edit command is for.

We'd like to seek clarification on what you mean by the following:

As a user, one might be very bewildered because you would need to have read the edit section, realised that there is no way to "unbolt" and then realise that you can do this using edit, without it ever been told to you.

Duplicate status (if any):

Duplicate of #2887