search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Misleading picture #960

Open nus-se-script opened 2 months ago

nus-se-script commented 2 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.

image.png

There is no space between the delete and the -n flag making it seems like the proper user input has no space between the delete keyword and the -n flag

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

YHWong20 commented 2 months ago

Team's Response

Thanks for the bug. It is a fair point and can somewhat affect readability.

For context, there are whitespaces. It appears that the thickness of the boxes obscured this whitespace, thus, giving the impression that there is no whitespace in between the Command Word, Flag and Placeholder portions.

Regardless, I agree with the VeryLow severity. This shouldn't affect the functionality as the whitespaces can still be visibly seen in all other instances where the command is shown.

Duplicate status (if any):

--