neyapraveen / pe

0 stars 0 forks source link

Poor example command for find-some-tag and find-all-tag #10

Open neyapraveen opened 12 months ago

neyapraveen commented 12 months ago

In your sample data, you use the tag full-time. However in these sections, the example you gave is "full time" which causes me to see no data, which I am sure was not the intended purpose as you have correctly written it as full-time in add-tag and delete-tag.

image.png

nus-pe-script commented 11 months ago

Team's Response

The examples are meant to be self-contained and not tied to the sample data; the bullet point mentions a hypothetical scenario where the user might want to search for employees with both the remote and full time tags, and provides the command to tackle this exact scenario.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: There is still inconsistency with add-tag and delete-tag, where the examples were "add-tag 2 t/full-time t/remote" and "delete-tag 2 t/full-time t/remote". As the hyphens were added here, it definitely feels confusing and looks like a mistake in the documentation, since the find tag commands will not find any of the tags you have asked the user to add as an example, causing confusion! Though you did mention in the bullet point, it also does not help that in the documentation you clearly indicate that you can have two distinct tags full-time and full time which have the same meaning but do not give the same output, implying the application is overly sensitive to such inputs, hence I feel like this is a DocumentationBug of significance, and could have been avoided.