mattisongjj / pe

0 stars 0 forks source link

Telegram username constraint not specified in documentation #3

Closed mattisongjj closed 1 week ago

mattisongjj commented 1 week ago

When trying to add a telegram username, the constraint that the username needs must only contain alphanumeric characters or underscores and be between 5 to 32 characters long, and must start with a letter and not end with a underscore and an @ is not required at the start is not stated in the user documentation. This could lead end users to only find out upon adding a invalid telegram username

Steps to reproduce

  1. Run the application

  2. Try adding a invalid telegram username for example by using the command add_member n/John Dasdoe r/04-3-201 t/sks

  3. See that there is a constraint imposed on the telegram username that is not found in the user documentation

Screenshot 2024-11-15 at 4.38.01 PM.png

Expected Behavior

When adding a member and specifing a telegram user name, since there is a constraint on the username this constraint should be clearly stated on the user documentation

Actual Behavior

Telegram username input constraint is not found in the user documentation

Suggested Improvement

Add the telegram user name constraint in the user documentation to make it clear to first time users