Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Confusing use of ... part 2 #21

Open
JodyLorah opened this issue Apr 16, 2021 · 1 comment
Open

Confusing use of ... part 2 #21

JodyLorah opened this issue Apr 16, 2021 · 1 comment

Comments

@JodyLorah
Copy link
Owner

JodyLorah commented Apr 16, 2021

In the UG, it is shown that … means a certain field can be used more than once.

image.png

I dont think thats the case for this example given in the DG. This happens several times and I shall leave it here. Don't want to penalise y'all too many times :)

image.png

@nus-pe-bot
Copy link

nus-pe-bot commented Apr 20, 2021

Team's Response

Refer to #925.

The 'Original' Bug

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

Misleading use of ...

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.



In the UG, it is shown that ... means a certain field can be used more than once.

image.png

I dont think thats the case for this example given in the DG since name can only be added once

image.png


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

Their Response to the 'Original' Bug

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

That definition of the ellipsis is meant for the user guide, not for the developer guide. For the developer guide, it is clear what the ellipsis means.

Items for the Tester to Verify

❓ Issue duplicate status

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

  • I disagree

Reason for disagreement: [replace this with your explanation]


❓ Issue response

Team chose [response.Rejected]

  • I disagree

Reason for disagreement: That is even worse, since you are using a symbol that you did not explain in the DG. Ellipses, as shown in both the UG and DG have different meanings, making it confusing for the user especially since it is not explained in the DG what the ellipsis is for. You cannot assume the reader knows which meaning you are trying to implement.


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants