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

Add support for function/module docstrings #7

Open
darrencruse opened this issue Dec 6, 2015 · 0 comments
Open

Add support for function/module docstrings #7

darrencruse opened this issue Dec 6, 2015 · 0 comments

Comments

@darrencruse
Copy link
Owner

In addition to the "atoms" retaining line/col info for source maps, there is also source for passing comments in the source out to the generated code.

Unfortunately I had trouble getting that to work cleanly though and disabled it - right now source comments do not transfer to the generated javascript code.

It seems like function docstrings would be a wonderful compromise though. i.e. being able to describe what functions do and what the inputs and outputs are in a way that can be extracted seems the most important kind of comment and s-expressions make that much wonderfully easy (i.e. if these are a standard option for function declaration s-expression forms they're much easier to deal with than arbitrary comments anywhere/everywhere which is what I'd been trying to support).

https://en.wikipedia.org/wiki/Docstring

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

No branches or pull requests

1 participant