search

nus-cs2103-AY2223S1 / pe-dev-response

0 stars 0 forks source link

Missing command in table of contents and command section header #2160

Open nus-pe-bot opened 2 years ago

nus-pe-bot commented 2 years 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

image.png

image.png

The -u prefix is only introduced in the format section and was not introduced in any of the features' section headers. A user would not be able to find the -u prefix without carefully reading through the entire section, in contrary to all the other sections which have the appropriate prefixes displayed.

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

ConradLew commented 2 years ago

Team's Response

Thanks for the bug report! Our team acknowledges that the format could be made clearer in the section header, however we feel that the bug should not be of 'Medium' severity and should be changed to 'Low' instead because the -u flag is mentioned within the paragraph itself and is also included under the command summary. Most users can still discover the command after reading through the paragraph/summary thoroughly and only causes a minor inconvenience.

image.png

The issue is also a duplicate of #127 which points out inaccuracies in the heading.

Duplicate status (if any):

Duplicate of #127