search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Inconsistent naming convention used in the UG and the command line program #2533

Open nus-pe-bot opened 7 months ago

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

image.png

A few examples. Conventions also says that square brackets are optional and angled brackets are compulsory, so in that sense it makes it hard to follow

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

yeozhishen commented 7 months ago

Team's Response

Bug Chosen to address: the square brackets in the UG does not enclose the "/a" option in the list command

Duplicate status (if any):

--