Skip to content

doco changes #24

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

doco changes #24

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
661777b
doco tidies
soniah Jun 23, 2020
9d55fc8
PR fixes
soniah Jun 24, 2020
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
15 changes: 9 additions & 6 deletions User Guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,10 +239,11 @@ bash $

### Semi-compact printing

Semi-compact output can be obtained by combining the `-c` and `-t` flags, for
example `-t5c`. All _JSON iterables_ made of only _atomic values_ or empty
iterables (`[]`, `{}`) will be printed in a single line, the rest will be
pretty-printed:
The `-c` flag accepts an optional `t` suffix, that gives semi-compact output
- all _JSON iterables_ made of only _atomic values_ or empty iterables (`[]`,
`{}`) are printed on a single line, the remainder are pretty-printed. The `t`
suffix defaults to 3 spaces, this can be changed with an additional `N` suffix,
for example `-tc5`.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- it's way around:

The -t flag accepts an optional c suffix, ...

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything else looks good. I'll merge after fixing that typo.


```bash
bash $ <ab.json jtc -tc
Expand Down Expand Up @@ -309,7 +310,9 @@ bash $
### Validating JSON

When JSON is read (from a file or `stdin`), it gets parsed and validated. If
invalid JSON is detected, a short exception message will be displayed:
invalid JSON is detected, a short exception message will be displayed. For example
in this case, an unexpected end of line:

```bash bash $ <ab.json jtc
jtc json parsing exception (<stdin>:1214): unexpected_end_of_line
bash $
Expand All @@ -336,7 +339,7 @@ the beginning of the input/file/stream. In this example `jtc` found an
unexpected end of line in `"CO,` (the JSON standard doesn't permit multi-line
strings). To fix this, the missing quotation mark must be added.

Multiple debug flags (`-dd`, `-ddd`) can be used to gain greater insight.
Multiple debug flags (`-dd`, `-ddd`, etc) can be used to gain greater insight.

### Forcing strict solidus parsing

Expand Down