Suggest heredocs for multiline string wraps

[charlesrocket]

Suggest heredocs as main way to wrap multiple lines of strings due its ability to remove leading whitespaces.

[straight-shoota]

Thanks for bringing this up. Could you be a bit more specific, though? Where do you suggest to use heredoc? What kind of action would you expect from this issue? Thanks!

[Blacksmoke16]

To add some context, this discussion came up on Discord, with the gist of it being when using a multiline string in a nested namespace like:

module MyApp
  INTRO = "
  foo
  bar"
end

That the extra whitespace before foo and bar is unexpected, and you have to do like:

module MyApp
  INTRO = "
foo
bar"
end

to remove them, which forces you to ignore the indentation of the constant.

The thinking behind this issue is to add something to https://crystal-lang.org/reference/1.3/syntax_and_semantics/literals/string.html#multiline-strings to suggest you most likely want to use a heredoc, as afaik, a heredoc can do everything a multiline string can do, but in a more idiomatic way. Or in other words, essentially deprecate multiline strings in favor of heredocs within the documentation.