Concept: Here Documents

[glennj]

Next concept: here documents and here strings.

[IsaacG]

This doc is largely written in the passive voice. Was that an intentional choice?

[glennj]

This doc is largely written in the passive voice. Was that an intentional choice?

That's the way Google Gemini spat it out at me, and I didn't do a rewrite.

[glennj]

@kotp @IsaacG
Do you think it's worthwhile to add a "when not to use heredocs" section?

I'm thinking about an opinion like "scripts are for code, documents are data and should be shipped in a separate file. Besides, long blocks of text break the flow of the code."

[IsaacG]

@kotp @IsaacG Do you think it's worthwhile to add a "when not to use heredocs" section?

I'm thinking about an opinion like "scripts are for code, documents are data and should be shipped in a separate file. Besides, long blocks of text break the flow of the code."

I wouldn't be so prescription. Maybe list it as a potential drawback vs "don't use them".

"Here docs are great for X, Y, Z. However, they can sometimes break the flow of the code and make the code harder to read."

[kotp]

@kotp @IsaacG Do you think it's worthwhile to add a "when not to use heredocs" section?

I'm thinking about an opinion like "scripts are for code, documents are data and should be shipped in a separate file. Besides, long blocks of text break the flow of the code."

A typical uses list could be nice. An example of "poor formatting" and "good formatting" options can be useful.

[glennj]

@IsaacG if you can, please have a look at today's commits.

[glennj]

@kotp are you sufficiently satisfied? Are there changes you'd like?