Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Block Comments In Coffeescript files #232

Open
lovehasnologic opened this issue May 19, 2015 · 1 comment
Open

Block Comments In Coffeescript files #232

lovehasnologic opened this issue May 19, 2015 · 1 comment

Comments

@lovehasnologic
Copy link

I'm having an issue with hologram documentation in coffeescript files.

/*doc

*/

is invalid coffee script and results in the following error in the console:

[Error] Error: ExecJS::RuntimeError: SyntaxError: [stdin]:1:2: regular expressions cannot begin with *
  (in /path/to/file.js.coffee)
    (anonymous function) (application.js, line 1)

Wrapping it in a coffeescript block comment...

###
/*doc

*/
###

...causes the following console error.

[Error] Error: ExecJS::RuntimeError: SyntaxError: [stdin]:17:1: block comments cannot contain */
  (in /path/to/file.js.coffee)
    (anonymous function) (application.js, line 1)

Finally, using only the block comment results in no errors, but also no hologram output for the file.

###doc

###

Thoughts? My expertise rests mainly in HTML and CSS. My knowledge of Ruby/Rails is novice at best, and centers around the views and assets folders. My javascript expertise is mostly adding and removing classes on triggered events to update the interface. Therefore, apologies in advance if there is an easy answer to this issue that I missed.

@ahorner
Copy link

ahorner commented Jun 5, 2015

The last construct compiles to the correct value. See an example. Looking at the README, though, seems to indicate that hologram doesn't currently support documentation for any javascript pre-compilers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants