Skip to content

Commit 265841f

Browse files
authored
docs: improve clarity of sentences (#1489)
* docs: improve clarity of sentences Improved clarity by rephrasing sentences in the best practices section. * docs: improve best practices section * use appropriate formatting for stdin * include EOF in abbreviated form * docs: clarify sentence * change 'know that' -> 'note that' * use neither nor for better clarity
1 parent b16392f commit 265841f

File tree

1 file changed

+2
-5
lines changed

1 file changed

+2
-5
lines changed

docs/README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2395,12 +2395,9 @@ fi
23952395
The default behavior of automatically reading `stdin` is typically not desirable during non-interactive invocations.
23962396
You most likely want to use the `--ignore-stdin` option to disable it.
23972397
2398-
It is a common *gotcha* that without this option HTTPie seemingly hangs.
2399-
What happens is that when HTTPie is invoked, for example, from a cron job, `stdin` is not connected to a terminal.
2400-
Therefore, the rules for [redirected input](#redirected-input) apply, i.e. HTTPie starts to read it expecting that the request body will be passed through.
2401-
And since there’s neither data nor `EOF`, it will get stuck. So unless you’re piping some data to HTTPie, the `--ignore-stdin` flag should be used in scripts.
2398+
It's important to note that without the `--ignore-stdin` option, HTTPie may appear to have stopped working (hang). This happens because, in situations where HTTPie is invoked outside of an interactive session, such as from a cron job, `stdin` is not connected to a terminal. This means that the rules for [redirected input](#redirected-input) will be followed. When `stdin` is redirected, HTTPie assumes that the input will contain the request body, and it waits for the input to be provided. But, since there is neither any input data nor an end-of-file (`EOF`) signal, HTTPie gets stuck. To avoid this problem, the `--ignore-stdin` flag should be used in scripts, unless data is being piped to HTTPie.
24022399
2403-
Also, it might be good to set a connection `--timeout` limit to prevent your program from hanging if the server never responds.
2400+
To prevent your program from becoming unresponsive when the server fails to respond, it's a good idea to use the `--timeout` option to set a connection timeout limit.
24042401
24052402
## Plugin manager
24062403

0 commit comments

Comments
 (0)