wapisai / pe

0 stars 0 forks source link

too many unecessary exmaples #35

Open wapisai opened 6 months ago

wapisai commented 6 months ago

Screenshot 2024-04-19 at 5.33.22 PM.png

there are 3 link examples which is unecessary bc they really do the same thing

nus-se-script commented 6 months ago

Team's Response

In fact, these are not repetitive examples. Each one has its own purpose. The link 1 shows that it is able to use link command with a single input. The link 1 2 3 shows that it is able to use a link command with multiple inputs. The link 1 2 3 4 5 shows that the number of ids doesn't matter(can be any number), by showing that both 3 and 5 parameters work. This is essential as command receiving unrestricted number of index is uncommon in our app, so it really helps reader's understanding.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Repetitive examples in UG for link command

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.


image.png

Maybe could exclude the last example.


[original: nus-cs2103-AY2324S2/pe-interim#4788] [original labels: type.DocumentationBug severity.VeryLow]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

In fact, these are not repetitive examples. Each one has its own purpose. The link 1 shows that it is able to use link command with a single input. The link 1 2 3 shows that it is able to use a link command with multiple inputs. The link 1 2 3 4 5 shows that the number of ids doesn't matter(can be any number), by showing that both 3 and 5 parameters work. This is essential as command receiving unrestricted number of index is uncommon in our app, so it really helps reader's understanding.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]


## :question: Issue response Team chose [`response.Rejected`] - [x] I disagree **Reason for disagreement:** I understand the first 2 examples, but the last one is very repetitive Your justification for this is that "The link 1 2 3 4 5 shows that the number of ids doesn't matter(can be any number), by showing that both 3 and 5 parameters work. This is essential as command receiving unrestricted number of index is uncommon in our app, so it really helps reader's understanding." but this example doesnt tell me that the number of ids doesnt matter, it just shows me that it can take in 5 ids, making this example unnecessary u couldve just explicitly said that the number of ids doesnt matter, instead of including an unnecessary and unhelpful and repetitive example.
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]