mirror of
https://github.com/httpie/cli.git
synced 2024-11-22 07:43:20 +01:00
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
This commit is contained in:
parent
b16392fbb9
commit
265841f866
@ -2395,12 +2395,9 @@ fi
|
|||||||
The default behavior of automatically reading `stdin` is typically not desirable during non-interactive invocations.
|
The default behavior of automatically reading `stdin` is typically not desirable during non-interactive invocations.
|
||||||
You most likely want to use the `--ignore-stdin` option to disable it.
|
You most likely want to use the `--ignore-stdin` option to disable it.
|
||||||
|
|
||||||
It is a common *gotcha* that without this option HTTPie seemingly hangs.
|
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.
|
||||||
What happens is that when HTTPie is invoked, for example, from a cron job, `stdin` is not connected to a terminal.
|
|
||||||
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.
|
|
||||||
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.
|
|
||||||
|
|
||||||
Also, it might be good to set a connection `--timeout` limit to prevent your program from hanging if the server never responds.
|
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.
|
||||||
|
|
||||||
## Plugin manager
|
## Plugin manager
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user