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

dust doc improvements #29

Open
5 tasks
heyLu opened this issue Dec 23, 2015 · 3 comments
Open
5 tasks

dust doc improvements #29

heyLu opened this issue Dec 23, 2015 · 3 comments

Comments

@heyLu
Copy link
Member

heyLu commented Dec 23, 2015

dust doc exists now, thanks to @alekcz. Here are a few possible improvements to it. (Feel free to work on any of these, or add more, just say so in a comment.)

  • show usage message if no argument is passed (currently an exception)
  • load ns if symbol has an ns part, e.g. dust doc 'pixie.csp/put!' should work, even without -all
  • fix duplicate results for -all (with pixie.csp/put! it displays the docs multiple times, with somewhat strange output)
  • display signatures and examples as well
  • dust doc should work outside of project directories (for the default namespaces)
@alekcz
Copy link

alekcz commented Dec 23, 2015

Strange output? What does the output look like?

alekcz pushed a commit to alekcz/dust that referenced this issue Dec 24, 2015
-Updated read me
-Reworded deps command
-changed description to docstring
@heyLu
Copy link
Member Author

heyLu commented Dec 24, 2015

The docstring for the same function is repeated multiple times, but with invalid/strange symbols as the names, seemingly one for each namespace.

$ dust doc 'pixie.csp/put!' -all
  pixie.csp/pixie.csp/put!

    Puts the value into the channel, calling the optional callback when the operation has
   completed.


  pixie.uv/pixie.csp/put!

    Puts the value into the channel, calling the optional callback when the operation has
   completed.


  pixie.repl/pixie.csp/put!

    Puts the value into the channel, calling the optional callback when the operation has
   completed.


  pixie.streams/pixie.csp/put!

    Puts the value into the channel, calling the optional callback when the operation has
   completed.


  pixie.ffi-infer/pixie.csp/put!

    Puts the value into the channel, calling the optional callback when the operation has
   completed.


  pixie.io.common/pixie.csp/put!

    Puts the value into the channel, calling the optional callback when the operation has
   completed.


  pixie.io.tty/pixie.csp/put!

    Puts the value into the channel, calling the optional callback when the operation has
   completed.


  pixie.io.tcp/pixie.csp/put!

    Puts the value into the channel, calling the optional callback when the operation has
   completed.


  pixie.io.uv-common/pixie.csp/put!

    Puts the value into the channel, calling the optional callback when the operation has
   completed.


  pixie.io/pixie.csp/put!

    Puts the value into the channel, calling the optional callback when the operation has
   completed.


  pixie.io-blocking/pixie.csp/put!

    Puts the value into the channel, calling the optional callback when the operation has
   completed.


  pixie.fs/pixie.csp/put!

    Puts the value into the channel, calling the optional callback when the operation has
   completed.


  pixie.set/pixie.csp/put!

    Puts the value into the channel, calling the optional callback when the operation has
   completed.


  pixie.string/pixie.csp/put!

    Puts the value into the channel, calling the optional callback when the operation has
   completed.


  pixie.walk/pixie.csp/put!

    Puts the value into the channel, calling the optional callback when the operation has
   completed.

@alekcz
Copy link

alekcz commented Dec 26, 2015

@heyLu

dust doc  *
dust help  *
dust run *

This results in "deps" being sent as an argument. Any idea why this happens?

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