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

The @help macro does not show the docstrings for macros #37

Closed
piechologist opened this issue Nov 1, 2024 · 3 comments
Closed

The @help macro does not show the docstrings for macros #37

piechologist opened this issue Nov 1, 2024 · 3 comments

Comments

@piechologist
Copy link
Contributor

piechologist commented Nov 1, 2024

Example: @help @info displays just "#= =#" in the pager, not the docstring for @info.

I could track the issue down to the macro help(f) definition in helpers.jl, line 24. When calling @help @info in the REPL, the variable f_str is set to something like #= REPL[21]:1 =# @info.

I tried

local f_str = chopprefix(string(f), r"#= .+ =# ")

which is not elegant but it works fine.

I could make a PR for that or maybe you have a better solution?

@ronisbr
Copy link
Owner

ronisbr commented Nov 11, 2024

Hi @piechologist !

Sorry for the delay.

I took a look at the issue and I think your proposed solution is a great idea! If you could submit this PR, that would be awesome!

Thanks!

@piechologist
Copy link
Contributor Author

Works as intended in v0.6.0. Thanks for merging!

@ronisbr
Copy link
Owner

ronisbr commented Nov 20, 2024

Thanks for the fix @piechologist !

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