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

recognise julia code in docstrings #55

Open
dahtah opened this issue Sep 1, 2021 · 0 comments
Open

recognise julia code in docstrings #55

dahtah opened this issue Sep 1, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@dahtah
Copy link
Contributor

dahtah commented Sep 1, 2021

When using Documenter.jl for package docs, there is the option of including example code in a function's docstring by enclosing it with backticks. It'd be nice of julia-snail could recognise it as code instead of comment, so the user could hit C-c C-l for instance to test the example directly in the REPL. emacs-ess implements something similar for R's docstrings. I feel like this can be implemented relatively easily by fiddling with the syntax table somewhere?

Extra credit if julia-snail can manage to insert the correct "@jldoctest" output automatically.

@gcv gcv added the enhancement New feature or request label Sep 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants