Add comments and escapes to ECR docs #7121
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
src/ecr.cr
Outdated
| # Greeting, <%= @name %>! | ||
| # | ||
| # Greeting.new("John").to_s #=> Greeting, John! | ||
| # Greeter.new("John").to_s # => Greetings, John! |
There was a problem hiding this comment.
Could you wrap the result in quotes?
src/ecr.cr
Outdated
| # | ||
| # Greeting.new(nil).to_s #=> Greeting! | ||
| # Greeter.new(nil).to_s # => Greetings! |
There was a problem hiding this comment.
Ditto: quotes.
And maybe add a usage example with a name?
src/ecr.cr
Outdated
| # <%- @names.each do |name| -%> | ||
| # Hi, <%= name %>! | ||
| # <%- end -%> | ||
| # Greeter.new("John", "Zoe", "Ben").to_s |
There was a problem hiding this comment.
# => "Hi, John!\nHi, Zoe!\nHi, Ben!"
src/ecr.cr
Outdated
| # ``` | ||
| # require "ecr" | ||
| # foo = 2 | ||
| # string = ECR.render("demo.ecr") |
There was a problem hiding this comment.
There is no need for storing the result in a variable, just directly show the result. .inspect is not essential, either.
|
@straight-shoota Thanks for the comments, I believe I implemented them all correctly. |
ysbaddaden
approved these changes
Nov 27, 2018
sdogruyol
approved these changes
Nov 28, 2018
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.
PR #2004 added some new features to ECR, here are the docs to go with them.
Also, I felt like the language was a little awkward in the examples. Originally the class:
Greetingwould greet a user with the phraseGreeting, KCbut I believe it is more natural to call the class aGreeterand I'm sure (as a native English speaker) that the idiom is "Greetings, KC".Sorry if that kind of input isn't welcome, I don't mean to be pedantic. I'm happy to revert that aspect of this PR if requested :)