Give an example of a single line Hash. #9505
Conversation
Single kv hashes look like Ruby hashes, and people get confused. Let's make the example more explicit.
docs/static/configuration.asciidoc
Outdated
| @@ -188,6 +188,8 @@ match => { | |||
| "field2" => "value2" | |||
| ... | |||
| } | |||
| # or | |||
| match => { "field1" => "value1" "field2" => "value2" } | |||
There was a problem hiding this comment.
Hmm, what about spreading this on multiple lines to (hopefully) improve readability?
There was a problem hiding this comment.
The purpose of this addition is to clearly show how to do single line hashes. It gets people confused.
I agree that multi-line is clearer. But sometimes you just have 2 key-values, and the syntax that looks like Ruby hashes confuses people. They wonder why { "field1" => "value1", "field2" => "value2" } doesn't work.
That's also why I put the single line example just below the multi-line example. To convey that multi-line should be the first option.
There was a problem hiding this comment.
Ahh thanks for the explanation. My preference to avoid this in-line style blinded me to your goal.
Small suggestion, change # or to # or as a single line. No commas between entries:
|
Left a final small comment, and I leave it up to you which path to take (change the comment or not). Either way, LGTM. |
Single kv hashes look like Ruby hashes, and people get confused.
Let's make the example more explicit.