Fix UG and DG issues #279
Merged
Fix UG and DG issues #279
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
Codecov ReportAll modified and coverable lines are covered by tests ✅ |
chongtzezhao
approved these changes
Nov 10, 2024
docs/UserGuide.md
Outdated
| <box type="tip" seamless> | ||
|
|
||
| The field PUBLIC_ADDRESS is not cap sensitive. | ||
| This command only searches the current list of public addresses displayed(eg if all contacts is displayed |
There was a problem hiding this comment.
nit: (grammar) change "if all contacts is displayed" to "if all contacts are displayed"
Airiinnn
approved these changes
Nov 10, 2024
docs/DeveloperGuide.md
Outdated
Comment on lines
441
to
444
| add to future enhancements | ||
| The command 'forgiving' these extraneous inputs (i.e., giving an output same as or similar to if those inputs are not | ||
| present) is not incorrect. You can mention in the UG that such inputs will be ignored. AB3 already does a similar thing | ||
| for some commands. Any special handling of such inputs can be left as a future enhancement. |
docs/UserGuide.md
Outdated
| @@ -192,7 +216,7 @@ DLTbook comes with sample data to help you get started. Here are some basic comm | |||
| 3. **Add a DLT public address** | |||
|
|
|||
| ``` | |||
| addpa 1 c/BTC l/wallet1 pa/0x28f91d6e72eaf4372892e6c6e45dc41b574163e9fcdf94f4997958b46d772fa2 | |||
| addpa c/ETH n/Travis w/wallet1 pa/0x0b1c9e1fb5e13c797c7f0134641810e9a7ca14d2 | |||
docs/UserGuide.md
Outdated
|
|
||
| <box type="tip" seamless> | ||
|
|
||
| The field PUBLIC_ADDRESS is not cap sensitive. |
There was a problem hiding this comment.
Standardise to case sensitive? Or doesn't matter
There was a problem hiding this comment.
apologies, I shall use case-insensitive
docs/UserGuide.md
Outdated
| @@ -674,9 +733,9 @@ the data of your previous AddressBook home folder. | |||
| | **List** | `list` | | |||
| | **Help** | `help` | | |||
| | **Exit** | `exit` | | |||
| | **Add Public Address** | `addpa INDEX c/NETWORK l/WALLET_NAME pa/PUBLIC_ADDRESS`<br> e.g., `addpa 1 c/ETH l/wallet1 pa/0x28f91d6e72eaf4372892e6c6e45dc41b574163e9fcdf94f4997958b46d772fa2` | | |||
| | **Edit Public Address** | `editpa INDEX c/NETWORK l/WALLET_NAME pa/NEW_ADDRESS`<br> e.g., `editpa 3 c/BTC l/Daily wallet pa/14qViLJfdGaP4EeHnDyJbEGQysnCpwk3gd` | | |||
| | **Add Public Address** | `addpa c/NETWORK n/NAME w/WALLET_NAME pa/PUBLIC_ADDRESS`<br> e.g., `addpa c/ETH n/Travis w/wallet1 pa/0x0b1c9e1fb5e13c797c7f0134641810e9a7ca14d2` | | |||
docs/UserGuide.md
Outdated
| | **Retrieve Public Address** | `retrievepa l/WALLET_NAME [c/NETWORK] [n/PERSON_NAME]`<br> e.g., `retrievepa l/wallet1 c/BTC n/John` | | ||
| | **Delete Public Address** | `deletepa c/NETWORK [l/WALLET_NAME]`<br> e.g., `deletepa 1 c/BTC l/wallet1` | | ||
| | **Public Address Search** | `searchpa pa/PUBLIC_ADDRESS`<br> e.g., `searchpa pa/0x28f91d6e72eaf4372892e6c6e45dc41b574163e9fcdf94f4997958b46d772fa2` | | ||
| | **Delete Public Address** | `deletepa c/NETWORK [w/WALLET_NAME]`<br> e.g., `deletepa 1 c/BTC w/wallet1` | |
Nicholascyx
reviewed
Nov 10, 2024
docs/UserGuide.md
Outdated
| @@ -674,9 +730,9 @@ the data of your previous AddressBook home folder. | |||
| | **List** | `list` | | |||
| | **Help** | `help` | | |||
| | **Exit** | `exit` | | |||
| | **Add Public Address** | `addpa INDEX c/NETWORK l/WALLET_NAME pa/PUBLIC_ADDRESS`<br> e.g., `addpa 1 c/ETH l/wallet1 pa/0x28f91d6e72eaf4372892e6c6e45dc41b574163e9fcdf94f4997958b46d772fa2` | | |||
| | **Edit Public Address** | `editpa INDEX c/NETWORK l/WALLET_NAME pa/NEW_ADDRESS`<br> e.g., `editpa 3 c/BTC l/Daily wallet pa/14qViLJfdGaP4EeHnDyJbEGQysnCpwk3gd` | | |||
| | **Add Public Address** | `addpa INDEX c/NETWORK l/WALLET_NAME pa/PUBLIC_ADDRESS`<br> e.g., `addpa 1 c/ETH l/wallet1 pa/0x0b1c9e1fb5e13c797c7f0134641810e9a7ca14d2` |z | |||
docs/UserGuide.md
Outdated
| to the first person on the list `Alex Yeoh` under the ETH network with the wallet name `wallet1` and the public | ||
| address `0x28f91d6e72eaf4372892e6c6e45dc41b574163e9fcdf94f4997958b46d772fa2`. | ||
| * `addpa 1 c/ETH l/wallet1 pa/0x0b1c9e1fb5e13c797c7f0134641810e9a7ca14d2 | ||
| * ` adds a public address |
There was a problem hiding this comment.
Maybe adds a public address should be connected with the command, instead of being a new point?
This was referenced Nov 11, 2024
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.
Fixes #197, Fixes #198, Fixes #199, Fixes #206, Fixes #209, Fixes #223, Fixes #229, Fixes #231, Fixes #233, Fixes #234, Fixes #235, Fixes #237, Fixes #238, Fixes #244, Fixes #253, Fixes #258, Fixes #268, Fixes #269