Documentation Bug: There is no specification on what is allowed for each prefix.

[jeronkk]

Description:

There is no specification of table in the UserGuide that tells me what is allowed in each prefix. For example, whether if 9123 4567 or 212-555-1234 is allowed in the phone number prefix. This requires users to have to test it themselves without having a table to refer to on what is and isn't allowed.

Suggestions:

I suggest adding a table for the restrictions for each prefix at the bottom of the UserGuide together with the command summary.

[soc-se-bot]

[IMPORTANT!: Please do not edit or reply to this comment using the GitHub UI. You can respond to it using CATcher during the next phase of the PE]

Team's Response

Thank you for the bug report. However, according to the course website:

Based on the above guideline, we believe that it is not necessary to state the exact input constraints for every single parameter. Doing so would clutter the UG and make it unpleasantly long to read. From the error messages, it does state the specifications of the various parameters.
Furthermore, our constraints generally follow conventions that should cover almost all situations. For instance, our email validation follows the constraints specified in RFC 5321 and RFC5322, so a valid email should not fail the validation. Phone number validations also follow the maximum length specified in ITU-T E.164 which states that phone numbers should be a maximum of 15 numbers. As such, any valid and conventional inputs should be accepted. In the rare case that a user enters something invalid, the programme would show the constraints in the error message.

Items for the Tester to Verify

❓ Issue response

Team chose [response.NotInScope]

• I disagree

Reason for disagreement: [replace this with your explanation]

---