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

PPP Updates #292

Merged
4 commits merged into from
Apr 15, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -469,9 +469,9 @@ Step 5. `CurrentEdit#displayTempImage()` is called to display the opened image o
* *Alternative 2* : The user can open and edit multiple images.
** Advantage: Images can be edited simultaneously.
** Disadvantages:
*** `open` has to distinguish whether the user is opening an image from `assets` or `temp` directory.
*** Hard to distinguish whether the user is opening an image from `assets` or `temp` directory.
*** Requires many duplicates with different temporary names.
*** Might be confusing for the user.
*** May be confusing for the user.

Alternative 1 was chosen as it is less complicated, requires lesser space and more user-friendly.
// end::DGOpen[]
Expand All @@ -483,7 +483,7 @@ Alternative 1 was chosen as it is less complicated, requires lesser space and mo
This command displays the names of all the files in the `assets` directory.

==== Current Implementation
The `listfiles` function is facilitated by `Album`. It uses the following operations:
The `listfiles` function is facilitated by `Album`. It uses the following operation:

* `Album#getFileNames()` - Returns a list of all the files in `assets` directory.

Expand Down Expand Up @@ -681,7 +681,7 @@ The following is an example usage scenario of how `save` behaves at each step as

Step 1. The user executes `save`.

Step 2. `CurrentEdit#tempImageExist()` is called to check if an image was previously opened. If `open` was not called previously, `CommandException` is thrown.
Step 2. `CurrentEdit#tempImageDoNotExist()` is called to check if an image was previously opened. If `open` was not called previously, `CommandException` is thrown.

Step 3. `CurrentEdit#getTempImage()` is called to retrieve the `tempImage` from `CurrentEdit`.

Expand Down
Binary file modified docs/diagrams/Zack.pptx
Binary file not shown.
Binary file modified docs/images/SaveCommandSequenceDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 2 additions & 6 deletions docs/team/itszp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -85,10 +85,8 @@ https://github.com/CS2103-AY1819S2-W14-2/main/issues/224[#224]

== Contributions to the User Guide

This section highlights my contributions to the User Guide. It showcases my ability to write documentation targeting end-users.

|===
|_Given below are sections I that contributed to the User Guide. They showcase my ability to write documentation targeting end-users._
|===
=== *Features*
'''
include::../UserGuide.adoc[tag=FeaturesHeader]
Expand All @@ -104,9 +102,7 @@ include::../UserGuide.adoc[tag=UGSave]

== Contributions to the Developer Guide

|===
|_Given below are sections that I contributed to the Developer Guide. They showcase my ability to write technical documentation and the technical depth of my contributions to the project._
|===
The section highlights my contributions to the Developer Guide. It showcases my ability to write technical documentation and the technical depth of my contributions to the project.

=== *Open Feature*
'''
Expand Down