search

nikolalsvk / render_async

render_async lets you include pages asynchronously with AJAX
https://rubygems.org/gems/render_async/
MIT License
1.08k stars 75 forks source link

Fix ERB comments in README #37

Closed SaladFork closed 6 years ago

SaladFork commented 7 years ago

This is a pretty silly commit but while working on #36 I was trying to figure out why comments weren't colored appropriately. Comments in erb files have a <%# comment %> syntax rather than # comment as per Ruby. I'm not convinced this is a good change as it adds noise and might take away from the readability of the code sample, but is technically more correct (and it now colors it in grey-ish).

This PR replaces all such occurrences in README.md.

nikolalsvk commented 7 years ago

Great that you noticed this.

I'm not convinced this is a good change as it adds noise and might take away from the readability of the code sample

I agree, I have 2 ideas on my mind:

  1. do you think HTML comments would be better maybe <!-- -->?
  2. what about extracting file names from code snippets and adding them to the text above the code snippet?
nikolalsvk commented 6 years ago

I've extracted the filenames from the codeblock, thanks for bringing this up @SaladFork 🍺