search

nus-cs2113-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Typo error in documentation parameter which caused confusion in testing #1387

Open nus-pe-bot opened 3 years ago

nus-pe-bot commented 3 years 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.

There is a type: c/ture, which confused me for a little bit when I was testing the feature. When tested with c/ture, the URL check feature did not work. Screen Shot 2021-04-16 at 5.29.52 PM.png

[original: nus-cs2113-AY2021S2/pe-interim#1387] [original labels: severity.Low type.DocumentationBug]

NgManSing commented 3 years ago

Team's Response

If c/true is added as an optional parameter, it will check if the provided URL is valid or not. (It requires internet access.)

For example: https://www.google.com/ --> valid www.google.com --> invalid (It is invalid since www.google.com is missing "https" and not formatted correctly. TraceYourProj will not help with formatting and adding protocol keywords like browsers.)

Duplicate status (if any):

--