-
Notifications
You must be signed in to change notification settings - Fork 6
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 guide #258
Update guide #258
Conversation
Codecov Report
@@ Coverage Diff @@
## master #258 +/- ##
============================================
- Coverage 51.06% 50.29% -0.77%
+ Complexity 851 834 -17
============================================
Files 197 195 -2
Lines 3629 3575 -54
Branches 400 390 -10
============================================
- Hits 1853 1798 -55
- Misses 1655 1656 +1
Partials 121 121
Continue to review full report at Codecov.
|
@@ -263,13 +257,14 @@ private void assertCommandFailure(String inputCommand, Class<? extends Throwable | |||
/** | |||
* A stub class to throw an {@code IOException} when the save method is called. | |||
*/ | |||
private static class JsonItemListIoExceptionThrowingStub extends JsonItemListStorage<Person, JsonAdaptedPerson> { |
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.
@ZoroarkDarkrai I am not sure if this class is being used? If i recall correctly it is only used in line 94, which is being removed
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.
Idk either? I was just removing person from AB3.
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.
better remove it? or would it be useful in the future?
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.
Maybe we leave it here first.
docs/UserGuide.md
Outdated
- At least one of the optional fields must be provided. | ||
|
||
Examples: | ||
- `edit int 7 i/1 w/2000 r/Java r/Python` | ||
- `edit int 4 i/4 j/ML Engineer` | ||
- Executing: `edit int 1 i/2 w/4800 r/Java r/Python` will change: | ||
|
||
![EditInternshipBefore](images/EditInternshipBefore.png) | ||
|
||
to: | ||
|
||
![EditInternshipAfter](images/EditInternshipAfter.png) | ||
|
||
- `edit int 3 i/1 j/Frontend Developer` |
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 think it could be better to specify a note saying that the details of the application made for this internship will also be updated accordingly.
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.
Maybe add an image to supplement that too!
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.
image of the application?
docs/UserGuide.md
Outdated
- At least one of the optional fields must be provided. | ||
|
||
Examples: | ||
- `edit int 7 i/1 w/2000 r/Java r/Python` | ||
- `edit int 4 i/4 j/ML Engineer` | ||
- Executing: `edit int 1 i/2 w/4800 r/Java r/Python` will change: | ||
|
||
![EditInternshipBefore](images/EditInternshipBefore.png) | ||
|
||
to: | ||
|
||
![EditInternshipAfter](images/EditInternshipAfter.png) | ||
|
||
- `edit int 3 i/1 j/Frontend Developer` |
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.
Maybe add an image to supplement that too!
InternHunter automatically saves user data after every command. The following sequence diagram demonstrates how | ||
InternHunter does it. Let `commandString` be any valid command string. | ||
|
||
![SavingDataSequenceDiagram](images/SavingDataSequenceDiagram.png) |
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 its not rendering on github? does your image render properly locally?
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.
Also I don't think StorageManager is in :Model?
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.
nice catch! and it does
LGTM |
Add internship ss
Clear command -> ug,dg
Storage -> dg
Command summary