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

Update User Guide #36

Merged
merged 1 commit into from Sep 27, 2019
Merged

Conversation

crazoter
Copy link

Made significant updates to the user guide which can be found at https://github.com/AY1920S1-CS2103-F10-1/main/blob/master/docs/UserGuide.adoc on GitHub and https://ay1920s1-cs2103-f10-1.github.io/main/UserGuide.html online.

Take note of the following:

  1. Sections of the UG marked as [INCOMPLETE UG] or [Parameters not updated] are incomplete and need to be finished by the developer.
  2. The user guide is an AsciiDoc format. I recommend using Visual Studio Code and installing the asciidoctor visual studio code extension. (https://marketplace.visualstudio.com/items?itemName=joaompinto.asciidoctor-vscode) to edit this document.
  3. Note that in the current implementation of AB3, the index of an object is variable; in other words if you use find its index will change. In our implementation (as defined in the user guide), this index is non-variant; in other words, an item will always have the same index regardless of whether it was displayed via patient list or patient find. This is to facilitate other more complicated commands such as patient add medcon which require the user to select both a patient and a medical condition.

@crazoter crazoter merged commit eb6c9f2 into AY1920S1-CS2103-F10-1:master Sep 27, 2019
@crazoter
Copy link
Author

crazoter commented Oct 2, 2019

part of #49

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

Successfully merging this pull request may close these issues.

None yet

1 participant