search

jyztintan / pe

0 stars 0 forks source link

Missing blankspace in deletetask example #22

Open jyztintan opened 2 months ago

jyztintan commented 2 months ago

We see that a blank space is required after the prefix for /selecttask image.png

However in the command summary, it lacks this whitespace

image.png

This could inconvenience users who copy and paste the example command format from this summary.

nus-se-script commented 2 months ago

Team's Response

Both issues involve the problem where there is no white space between the field prefix and the field value in the UG. As mentioned in the other issue, this pertains to space characters surrounding line-breaks being omitted, and we have warned about it.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Add command examples standardisation with the actual command format

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.

Screenshot 2024-04-19 at 5.30.28 PM.png

For the above image, it is mentioned in that the add command requires a space after the command flag. Eg /poc/ + +jane yeo`

Screenshot 2024-04-19 at 5.30.45 PM.png

However, for the examples provided above, there is a missing space between /poc and the name of the person.

This missing space can leave users confused on which command format is correct/incorrect as it is not mentioned specifically. Therefore, it can be more useful to edit the examples to contain the space so that the command format matches that as specified.

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

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

image.png

We have specified for the users that copying the lines directly may break the spacing for the command at the start of Tutorial. The user is expected to add the spacing between lines if it is missing after copying and pasting.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

## :question: Issue response Team chose [`response.Rejected`] - [x] I disagree **Reason for disagreement:** I respectfully disagree with the team’s decision to reject the issue based on their warning provided at the start of the Tutorial section. As the team has already pointed out, the inconsistency of the command examples within the documentation itself is significant and the underlying issue still exists. The potential for copying errors due to PDF formatting is also still present, which still presents an inconvenience to readers.
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]