-
Notifications
You must be signed in to change notification settings - Fork 5
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
Add Images and change formatting of the User Guide #309
Add Images and change formatting of the User Guide #309
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Other than a few nits, LGTM!
For the screenshots, is there a sequence to it? as some addresses 2nd index as Bernice, others Charlotte.
Might want to add a disclaimer that the examples are sequential.
docs/images/addStudent.png
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hmm this comment goes to all images ah.
Should we photoshop and make the strings wrap text? or temporatily make it wrap text in the output? so that users can see the full result display.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm I basically deleted my data file then started screenshotting and doing the commands in order. But I not sure how we gonna say that its sequential though
<br> | ||
|
||
#### 👀Viewing Help : `help` | ||
#### Clearing all Entries : `clear` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good catch on this!
docs/UserGuide.md
Outdated
> **Input:** `clear` Deletes all students in F.A.K.E.J.A.R.V.I.S. | ||
> | ||
> **Output:** | ||
>`Address book has been cleared!` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just occurred to me, should we change Address Book to F.A.K.E.J.A.R.V.I.S here?
i.e update UG and code. Seems like a bug sia.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure whether we can for this though. I think its fine?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Other than the part with deletecomment having highlighted output, LGTM. Thanks for taking all these screenshots!
docs/images/deletecomment.png
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure why the text here is highlighted
No description provided.