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

help/1 in the REPL? #115

Closed
oubiwann opened this issue Mar 9, 2015 · 4 comments
Closed

help/1 in the REPL? #115

oubiwann opened this issue Mar 9, 2015 · 4 comments

Comments

@oubiwann
Copy link
Member

oubiwann commented Mar 9, 2015

Do you think it would be possible to, in addition to the already-supported help/0 in the REPL, to have a help/1 for displaying module man pages?

> (help io_lib)
@rvirding
Copy link
Member

It would be possible if the man pages are downloaded into the "right places", otherwise not.

@arpunk
Copy link
Contributor

arpunk commented Jun 24, 2015

What about being able to printing out the docstring of a function via help/1?

EDIT: Nevermind, I just saw the referenced issues: #87 and #67

@oubiwann
Copy link
Member Author

I think I like the idea of help/2 and help/3 as names, instead of describe. help/1 could even be used to get the help of REPL functions. This last would require that the help text for each REPL function be stored somewhere (perhaps in lfe_shell using the docstring module attributes, as proposed in the other ticket?). It would also mean that the output for help/0 could be generated automatically ...

@oubiwann
Copy link
Member Author

Lots of good work has gone into a solution for this problem; with LFE 2.0 we're even going to have support for Elixir docs metadata, etc.

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

3 participants