search

nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

No description of what is an invalid edit #3721

Open nus-se-script opened 10 months ago

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

Screenshot 2023-11-17 at 5.31.41 PM.png

As an advanced user, I am unable to tell what is an invalid edit. This is a serious problem as I have struggled to figure out what is the correct way to edit the data file.

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

mfjkri commented 10 months ago

Team's Response

I understand that it can be challenging to discern valid edits.

As advanced users like yourself, you can seamlessly follow the format of existing data stored in the data file to make logical edits. The sample data that the app starts with serves this purpose well as it contains both tutors and schedules and illustrates the association between the two in the data file.

TutorConnect warns users who intend to use this feature to be careful and sure of the changes they would like to make before proceeding and always make a backup.

Duplicate status (if any):

--