docs: correct spelling, YARD formatting

[olleolleolle]

This tries to format the example to hold lines together, and using an indent level.

I saw that the first code line wasn't understood by YARD.

Screenshots: After this change

The module, I could not get it to render highlighting:

The regular class worked per normal:

Screenshots: Before this change

[stympy]

Thanks! I'll get this merged once I get our test matrix cleaned up.

[zverok]

The module, I could not get it to render highlighting

(Sorry, just passed by)

The highlighting usually not turned on when the Ruby is invalid. The example is not a valid Ruby, in particular this line:

metric_attributes { foo: bar }
# SyntaxError ((irb):3: syntax error, unexpected ':', expecting '}')
# metric_attributes { foo: bar }
#                        ^

...because it is interpreted as a method receiving block (not a hash), and foo: bar is invalid block contents.

For all I know, this is the only ways to write this:

metric_attributes({ foo: bar })
# or just
metric_attributes(foo: bar)

[stympy]

@zverok Thanks!

[olleolleolle]

@zverok ❤️ Thanks, and good to see you!