UG Notes on optional arguments can be misleading

gavingoh99 / pe

0 stars 0 forks source link

UG Notes on optional arguments can be misleading #9

Open gavingoh99 opened 6 months ago

gavingoh99 commented 6 months ago

In the UG, it is specified that

Screenshot 2024-04-19 at 5.20.16 PM.png

Since the --tags=TAG argument is in square brackets, a user would expect that it is optional and can be omitted. However, the explanation mentioned instead that the command could be used as --tags=John Doe, leaving the name argument out instead.

This mismatch between the notation and explanation can be confusing to new users!

soc-se-bot commented 6 months ago

Your response not required for this bug as the team has accepted the bug as it is.