ThomasHoooo / pe

0 stars 0 forks source link

checkout command in ug accepts filename with extension #9

Open ThomasHoooo opened 1 year ago

ThomasHoooo commented 1 year ago

image.png

The ug specified that filename with extension will not be accepted. However, when i run checkout addressbook.json, it actually works.

image.png

nus-se-bot commented 1 year ago

Team's Response

As stated in the UG, the FILE_NAME should not include any extension. However to perform input validation on all file extensions is not feasible as there may be newer unknown file extensions in the future. In addition, most OS support file name with periods ., dashes -, and underscores _, which is accepted by our application. Hence, the following FILE_NAME are all valid when applied in the context of this application.

  1. addressbook.json -> with extension addressbook.json.json
  2. addressbook-json -> with extension addressbook-json.json
  3. addressbook_json -> with extension addressbook_json.json

    Items for the Tester to Verify

    :question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The ug is misleading and hence it is a documentation bug and has a low severity. When the ug stated that should not include file extensions, a sane reader will assume that file extensions cannot be included but in fact it allows. Hence, it is misleading and this should be a bug.