nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

parameters restriction can be clearified #3192

Open nus-se-script opened 5 months ago

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


Screen Shot 2024-04-19 at 5.32.55 PM.png

This part is lengthy, hard for users to read through. Restriction of the parameters can be separated using the "Caution" formatting as shown in below:

Screen Shot 2024-04-19 at 5.33.57 PM.png


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

gosongying commented 4 months ago

Team's Response

We believe placing these parameters under the "Caution" category might not be appropriate, as "Caution" typically applies to more serious issues. The parameter restrictions are merely precautions and not necessarily indicative of potential hazards.

Duplicate status (if any):

--