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

Terms in user guide can be quite confusing #4

Open
LimJiaJing opened this issue Nov 12, 2021 · 1 comment
Open

Terms in user guide can be quite confusing #4

LimJiaJing opened this issue Nov 12, 2021 · 1 comment

Comments

@LimJiaJing
Copy link
Owner

LimJiaJing commented Nov 12, 2021

image.png

image.png

UserGuide uses "module name" and "module code" , and "module" ambiguously. At times, "module name" should be more appropriate, but "module code" is used. Attached are some instances where the terms could confuse the user.

In the above two pictures, the command referred i assume it is the same, but the command format given in the UserGuide differs i.e. module name vs module. As a result, i tried to do "add Software Engineering and OOP", took away the space to "add_Software_Enginnering_and_OOP" and hit another error. Until I realised I had to put in a module code instead.

image.png

@soc-pe-bot
Copy link

soc-pe-bot commented Nov 16, 2021

Team's Response

No details provided by team.

The 'Original' Bug

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

Input for add is different between help and UG

image.png


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

Their Response to the 'Original' Bug

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

No details provided by team.

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 severity

Team chose [severity.VeryLow]
Originally [severity.Low]

  • I disagree

Reason for disagreement: This is a little confusing to explain. I agree that the bug stems from the same part of the documentation/code, however, the reasoning I gave behind the bug is different. In the case of the other bug report, I agree that its severity is verylow since how they report it makes it like a cosmetic issue. However, the reasoning I gave behind my bug report points towards causing users inconvenience during usage. This bug causes an inconvenience in usage, hence I marked it as severity.low.


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