Document suppressing newlines. #450
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I found myself writing multi-line action blocks to improve readability but could not understand why each action left a newline behind. Because I was running this in Docker Compose, I didn't want to alter the `ENTRYPOINT` to your image to do some data munging with `bash` to workaround it. I saw that some example code in your documentation had leading and trailing minus signs after and before the action delimiters. I figured this was worth something, so I used it in my code and discovered that this is how you suppress newlines. While this is well-known for those that use Go templates, it wasn't clear to this not-yet-a-Golang dev. I added some documentation to explain this better for folks like me. I love this tool! Thank you for making it!
|
Hi @carlosonunez! Thanks so much for this submission. I find it difficult sometimes to write docs from the perspective of a non-Go-dev, so I appreciate this type of PR all the more! 😄 Overall, this is excellent. I have a few minor nitpicks, which I will add suggestions for in-line, and you can accept or reject them 😉 |
|
It would be useful to also reference the Go template documentation for those who are interested in digging deeper: https://golang.org/pkg/text/template/#hdr-Text_and_spaces |
Co-Authored-By: carlosonunez <[email protected]>
|
Agreed! I thought of doing this but didn’t know where to put it. Hang on. |
Reference Golang template behaviour.
Co-Authored-By: carlosonunez <[email protected]>
|
Done! |
hairyhenderson
approved these changes
Dec 21, 2018
|
@carlosonunez thanks again for this! I'm glad gomplate is useful for you 🙂 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I found myself writing multi-line action blocks to improve readability but could not understand why each action left a newline behind. Because I was running this in Docker Compose, I didn't want to alter the
ENTRYPOINTto your image to do some data munging withbashto workaround it.I saw that some example code in your documentation had leading and trailing minus signs after and before the action delimiters. I figured this was worth something, so I used it in my code and discovered that this is how you suppress newlines.
While this is well-known for those that use Go templates, it wasn't clear to this not-yet-a-Golang dev. I added some documentation to explain this better for folks like me.
I love this tool! Thank you for making it!