-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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.
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
Formalize @ suffix for all operators #1225
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code looks good 👍🏻
Docs need some tweaks 📓
ee6a5f2
to
c2ec3da
Compare
Codecov Report
@@ Coverage Diff @@
## master #1225 +/- ##
==========================================
- Coverage 97.28% 96.74% -0.55%
==========================================
Files 67 81 +14
Lines 4235 5431 +1196
==========================================
+ Hits 4120 5254 +1134
- Misses 115 177 +62
Continue to review full report at Codecov.
|
c2ec3da
to
83fd0b2
Compare
83fd0b2
to
9671bed
Compare
@jakubroztocil please re-review, I've tried to address your suggestions and make it a bit more simple. |
d031dca
to
7c3a999
Compare
docs/README.md
Outdated
$ http PUT pie.dev/put \ | ||
X-Date:today \ # Header | ||
token==secret \ # Query parameter | ||
name=John \ # String (default) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
String (default)
doesn’t explain what it does
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The space before the comments don’t need to be to so big
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps
name=John \ # String (default) | |
name=John \ # String Data (JSON or Form) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The table below describes the concepts so the labels should be consistent with that. This is a data field.
docs/README.md
Outdated
$ http PUT pie.dev/put \ | ||
X-Date:today \ # Header | ||
token==secret \ # Query parameter | ||
name=John \ # String (default) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The space before the comments don’t need to be to so big
docs/README.md
Outdated
$ http POST pie.dev/post \ | ||
X-Data:@files/text.txt # Read a header from a file | ||
token==@files/text.txt # Read a query parameter from a file | ||
name=@files/text.txt # Read a string from a file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Again, "string" says nothing about how it’s used
docs/README.md
Outdated
@@ -871,6 +904,14 @@ Host: <taken-from-URL> | |||
|
|||
Any of these can be overwritten and some of them unset (see below). | |||
|
|||
### Reading headers from a file | |||
|
|||
You can read headers from a file by using the `:@` operator. This would also effectively strip the newlines from the end. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Back link to the section dedicated to the file operators
docs/README.md
Outdated
@@ -518,6 +518,12 @@ $ http https://api.github.com/search/repositories q==httpie per_page==1 | |||
GET /search/repositories?q=httpie&per_page=1 HTTP/1.1 | |||
``` | |||
|
|||
You can even retrieve the `value` from a file by using the `param==@file` syntax. This would also effectively strip the newlines from the end. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Back link to the section dedicated to the file operators
docs/README.md
Outdated
You can read headers from a file by using the `:@` operator. This would also effectively strip the newlines from the end. | ||
|
||
```bash | ||
$ http pie.dev/headers :@files/text.txt |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing header name
Resolves #964