Skip to content

Commit 501ae35

Browse files
authored
edit: explain error messages
1 parent 6e361b2 commit 501ae35

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ bash ./gh.sh insert SOME_PROP some_value OTHER_PROP other_value -- "~/.profile"
3333
bash ./gh.sh -v insert SOME_PROP some_value OTHER_PROP other_value -- "~/.profile"
3434
```
3535

36-
If `-v` (verbose) flag is used those are someresult examples:
36+
Return examples with `-v` (verbose) flag:
3737

3838
```sh
3939
[modified] export SOME_PROP=some_value
@@ -56,7 +56,7 @@ bash ./gh.sh delete SOME_PROP OTHER_PROP -- "~/.bash_profile"
5656
bash ./gh.sh -v delete SOME_PROP OTHER_PROP -- "~/.bash_profile"
5757
```
5858

59-
Returns examples with `-v` (verbose) flag:
59+
Return examples with `-v` (verbose) flag:
6060

6161
```sh
6262
[deleted] export SOME_PROP
@@ -76,7 +76,7 @@ bash ./gh.sh search SOME_PROP
7676
bash ./gh.sh insert SOME_PROP OTHER_PROP -- "~/.profile"
7777
```
7878

79-
Returns example:
79+
Return examples:
8080

8181
```sh
8282
export SOME_PROP=some_value
@@ -137,6 +137,14 @@ echo $gh_rcFile
137137
# ...
138138
```
139139

140+
### Error messages
141+
142+
When an error is encountered, even in silent mode (non `-v` verbose), you can expect this error messages format:
143+
144+
```sh
145+
[error] Some caught error message
146+
```
147+
140148
## Licence
141149

142150
MIT

0 commit comments

Comments
 (0)