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.

Sign up for GitHub

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

Jump to bottom

Fix developer guide typos command parser #374

Merged
merged 4 commits into from
Apr 10, 2023
Merged

Fix developer guide typos command parser #374

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
63162c3
Fix typo
nichyjt Apr 10, 2023
2e24f4c
Fix typo
nichyjt Apr 10, 2023
0dfe417
Fix code typo
nichyjt Apr 10, 2023
ffdbc2d
Merge branch 'master' into fix-DeveloperGuide-Typos-CommandParser
nichyjt Apr 10, 2023
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: 2 additions & 6 deletions docs/DeveloperGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -477,14 +477,10 @@ Due to the unique one-to-one relationship between arguments and payloads, we can
using this syntax using a `HashMap` mapping each `argument` to a `payload`.

For example,
`
$ foo bar --arg1 payload1 payload1--1 --arg2 payload2 --arg3
`
`foo bar --arg1 payload1 payload1--1 --arg2 payload2 --arg3`

Will be mapped as:
`
(foo, bar), (arg1 payload1 payload1--1), (arg2 payload2), (arg3, "")
`
`(foo, bar), (arg1 payload1 payload1--1), (arg2 payload2), (arg3, "")`
where `""` represents an empty string (for visualization).

Using a `HashMap` fulfils user design considerations (2), both developer design considerations (3), (4).
Expand Down