Update documentations for DG, UG and PPP #290
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was
linked to
issues
Nov 12, 2023
Codecov Report
@@ Coverage Diff @@
## master #290 +/- ##
============================================
+ Coverage 75.53% 76.19% +0.65%
- Complexity 686 694 +8
============================================
Files 103 103
Lines 2195 2197 +2
Branches 223 223
============================================
+ Hits 1658 1674 +16
+ Misses 473 467 -6
+ Partials 64 56 -8
... and 6 files with indirect coverage changes 📣 Codecov offers a browser extension for seamless coverage viewing on GitHub. Try it in Chrome or Firefox today! |
sopa301
approved these changes
Nov 12, 2023
docs/UserGuide.md
Outdated
| @@ -448,6 +455,8 @@ UNOFAS data are saved automatically as a JSON file `[JAR file location]/data/add | |||
|
|
|||
| <div markdown="span" class="alert alert-warning"> :exclamation: **Caution:** | |||
| If your changes to the data file makes its format invalid, UNOFAS will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it. | |||
|
|
|||
| Changing the `appointment` date to an invalid month (e.g. 13-13-2023) will cause an error and UNOFAS will not run. However, changing it to an invalid day (e.g. 31-02-2023), UNOFAS will update this date to the closest correct date (e.g. 28-02-2023). | |||
There was a problem hiding this comment.
We don't need to state this explicitly, we can just say that only correct edits will work, and that any wrong edits will lead to undefined behaviour, including the deletion of the entire data file.
Suggested change
| Changing the `appointment` date to an invalid month (e.g. 13-13-2023) will cause an error and UNOFAS will not run. However, changing it to an invalid day (e.g. 31-02-2023), UNOFAS will update this date to the closest correct date (e.g. 28-02-2023). | |
| If your changes to the data file makes its format invalid, UNOFAS will discard all data and start with an empty data file at the next run. Certain edits to the file may also cause unexpected behaviours. Please only edit the file if you are confident that it is correct, and it is recommended to take a backup of the file before editing it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update DG, UG and PPP