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

More representative examples in user guide: section on editing Events #8

Open
w-yeehong opened this issue Nov 13, 2020 · 1 comment

Comments

@w-yeehong
Copy link
Owner

w-yeehong commented Nov 13, 2020

Expected Outcome

Section on Editing an event should have examples that contain more recent dates & ideally different dates too.

Description

Examples for this section only use 23-10-1234 12:30 as the date and time.

image.png

@w-yeehong w-yeehong changed the title Section on editing Events should have more representative examples More representative examples in user guide: section on editing Events Nov 13, 2020
@nus-se-bot
Copy link

nus-se-bot commented Nov 18, 2020

Team's Response

Not a documentation bug. Example has no error and is easily understood.

Items for the Tester to Verify

❓ Issue response

Team chose [response.Rejected]

  • I disagree

Reason for disagreement: Hello, thank you for your response.

I understand that there is no error in the example. What I am concerned about is whether the example chosen in the guide is representative and clear to the user. Shouldn't an example try to showcase a command that the intended users would usually execute? This includes the parameters for the commands too. 1234 may not seem like a year from some years' perspective and can confuse them. Wouldn't it be better to use another year, perhaps 2016, which is more indicative that it is a year and probably more helpful for the users?

I do think the severity can be changed to VeryLow though.


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