Merge pull request #200 from JonathanLeeWH/master

Update documentation
CS2103-AY1819S2-T12-3 · Apr 15, 2019 · 6f42157 · 6f42157
2 parents 8e3607d + f16c5e2
commit 6f42157
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 7 deletions.
diff --git a/docs/DeveloperGuide.adoc b/docs/DeveloperGuide.adoc
@@ -1140,6 +1140,7 @@ Expected: No medicine is deleted. Error details shown in the status message. Sta
 .. Other incorrect delete commands to try: `delete`, `delete x` (where x is larger than the list size) +
 Expected: Similar to previous.
 
+// tag::exportcommandtest[]
 === Exporting as CSV file format
 
 . Exporting the current medicine inventory data shown in the GUI to CSV file format while all medicines are listed.
@@ -1165,6 +1166,7 @@ Expected: The current medicine inventory data shown in the GUI is successfully e
 Expected: The current medicine inventory data shown in the GUI is successfully exported to CSV file format. The exported CSV file has the default file name based on the date and time of export. The specific date and time format used if no file name is specified is `dd_MMM_yyyy_HH_mm_ss` e.g. `18_Mar_2019_10_28_00`. The exported CSV file's medicine inventory data will contain *only* the header information with no medicine data.
 .. Test case: `export example` +
 Expected: The current medicine inventory data shown in the GUI is successfully exported to CSV file format. The exported CSV file has the file name `example`. The exported CSV file's medicine inventory data will contain *only* the header information with no medicine data.
+// end::exportcommandtest[]
 
 // tag::warningtest[]
 === Changing warning panel thresholds

diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc
@@ -87,7 +87,7 @@ image::UserGuide_ApplicationInterface.png[width="1000"]
 // tag::uiwarningpanel[]
 *Warning Panel*
 
-* Displays a list of medicines running low on stock and a list of expiring/expired medicine batches.
+* The warning panel displays a list of medicines running low on stock and a list of expiring/expired medicine batches.
 * Warnings will be logged in the warnings panel until changes are made to medicines and/or batches displayed, or to the thresholds controlling what is displayed.
 * Image below shows the labelled components of the warning panel:
 +
@@ -403,8 +403,7 @@ Thresholds set by the user are saved and will be used when the application is la
 
 [IMPORTANT]
 =======
-All thresholds must be positive integers. +
-If the maximum threshold is set for a list, all medicines and/or batches will be displayed in that list.
+All thresholds must be positive integers.
 =======
 
 ****
@@ -422,7 +421,7 @@ Medicine batches that have expired or with expiry dates within 30 days to expiry
 Medicines with a total quantity of less than or equal to 10 will be displayed in the warning panel.
 
 * `warning show` +
-Current thresholds used for the warning panel will be shown in the result display as shown in figure below.
+Current thresholds used for the warning panel will be shown in the result display.
 // end::warningpanelcommand[]
 
 // tag::exportcommand[]

diff --git a/docs/team/flxffy.adoc b/docs/team/flxffy.adoc
@@ -34,9 +34,9 @@ image::PPP_Ui_WarningPanel.png[width="600"]
 
 ** Highlights: This enhancement required an understanding of all major components to render and populate a column in the application's main interface with the correct lists of items, and to implement complementing commands to change its contents.
 
-* *Code contributed*: [https://nus-cs2103-ay1819s2.github.io/cs2103-dashboard/#search=flxffy&sort=displayName&since=2019-02-10&until=2019-04-14&timeframe=day&reverse=false&repoSort=true[Project Code Dashboard]]
+* *Minor enhancement*: Changed the implementation of Expiry class so that it uses an updated library, (https://docs.oracle.com/javase/9/docs/api/java/util/Date.html[`java.time.LocalDate`]), instead of the deprecated (https://docs.oracle.com/javase/9/docs/api/java/util/Date.html[`java.util.Date`]).
 
-* *Minor enhancement*: Changed the implementation of the `Expiry` class. Previous implementation used a deprecated library (https://docs.oracle.com/javase/9/docs/api/java/util/Date.html[`java.util.Date`]) so it was changed to an updated one (https://docs.oracle.com/javase/9/docs/api/java/util/Date.html[`java.time.LocalDate`]).
+* *Code contributed*: [https://nus-cs2103-ay1819s2.github.io/cs2103-dashboard/#search=flxffy&sort=displayName&since=2019-02-10&until=2019-04-14&timeframe=day&reverse=false&repoSort=true[Project Code Dashboard]]
 
 * *Other contributions*:
 

diff --git a/docs/team/jonathanleewh.adoc b/docs/team/jonathanleewh.adoc
@@ -34,7 +34,7 @@ a|WARNING: {sp}
 
 This section highlights my documentation, coding and other noteworthy contributions to my team project.
 
-* *Major enhancement*: Added *`export` command support*
+* *Major enhancement: Added `export` command support*
 ** What it does: Allows the user to export the current medicine inventory data shown in the Graphical User Interface (GUI) to a spreadsheet file which is supported by commonly used spreadsheet applications such as Microsoft Excel.
 ** Justification: Allows the user to save the data so that it can be printed, organised or for advanced data analysis using a spreadsheet application such as Microsoft Excel. This is especially useful for the user, superior or supplier's reference.
 ** Highlights: This enhancement requires an indepth understanding of how each major components work and the methods available as it involves retrieving of data from the GUI and parsing the retrieved data. Despite using the Opencsv library, the implementation was still challenging as it required using methods from different components, parsing and organising the data such that the exported file contains only the essential information for easier reference.
@@ -57,6 +57,7 @@ This section highlights my documentation, coding and other noteworthy contributi
 *** Updated User Guide's Quick Start section and Developer Guide's Setting Up section to only allow Java version `9` and JDK `9` including references to the reason for the change: https://github.com/CS2103-AY1819S2-T12-3/main/pull/117[#117], https://github.com/CS2103-AY1819S2-T12-3/main/pull/123[#123]
 *** Updated User Guide Quick Start section with an additional step on how users can seek assistance: https://github.com/CS2103-AY1819S2-T12-3/main/pull/115[#115]
 *** Updated Storage component class diagram of Developer Guide to match our project: https://github.com/CS2103-AY1819S2-T12-3/main/pull/79[#79]
+*** Updated Developer Guide's Instructions for Manual Testing section to include instructions for testing the `export` command: https://github.com/CS2103-AY1819S2-T12-3/main/pull/197[#197]
 ** Community:
 *** PRs reviewed (with non-trivial review comments): https://github.com/CS2103-AY1819S2-T12-3/main/pull/24[#24], https://github.com/CS2103-AY1819S2-T12-3/main/pull/27[#27], https://github.com/CS2103-AY1819S2-T12-3/main/pull/40[#40], https://github.com/CS2103-AY1819S2-T12-3/main/pull/42[#42]
 *** Contributed to forum discussions (examples:  https://github.com/nus-cs2103-AY1819S2/forum/issues/6[1], https://github.com/nus-cs2103-AY1819S2/forum/issues/9[2], https://github.com/nus-cs2103-AY1819S2/forum/issues/11[3])