Re: [racket] Documentation enhancement suggestions

2012-01-04 Thread Grant Rettke
On Wed, Jan 4, 2012 at 11:22 AM, Vincent St-Amour wrote: > When the cursor is inside a function call and the operator is > recognized by eldoc (both standard library functions and user-defined > functions defined in the same file), the function's header and (if > known) return type is displayed in

Re: [racket] Documentation enhancement suggestions

2012-01-04 Thread Vincent St-Amour
At Mon, 2 Jan 2012 14:49:34 +, Erich Rast wrote: > But here is another suggestion that I would find > tremendously helpful: an auto-hover live help that pops up information > about function definitions plus a short explanation of what the function > does directly in the IDE, Similar to that, I

Re: [racket] Documentation enhancement suggestions

2012-01-03 Thread Rodolfo Carvalho
Hello, On Mon, Jan 2, 2012 at 15:35, Juan Fatas Huang wrote: > How about Sphinx? > I think that Sphinx collides with having Scribble -- the documentation toolset for Racket (and not only). Back to the Python department, I was reading some documentation today, and I found specifically helpful to

Re: [racket] Documentation enhancement suggestions

2012-01-02 Thread Juan Fatas Huang
How about Sphinx? Sphinx is a tool that makes it easy to create intelligent and beautiful > documentation, written by Georg Brandl and licensed under the BSD license. Benefits: -- host on github (for everyone who love to contribute) -- the website can run on http://readthedocs.org/ e.g. http://r

Re: [racket] Documentation enhancement suggestions

2012-01-02 Thread Robby Findler
Well, there is more to be done. It would be nice to get completion, etc. Someday. :) Robby On Mon, Jan 2, 2012 at 10:23 AM, Erich Rast wrote: > Oops...I didn't know that. Please disregard my last mail. > > Thanks a lot! > >> FWIW, in DrRacket, you can type f1 to search for the text that's at >>

Re: [racket] Documentation enhancement suggestions

2012-01-02 Thread Erich Rast
Oops...I didn't know that. Please disregard my last mail. Thanks a lot! > FWIW, in DrRacket, you can type f1 to search for the text that's at > the current insertion point and you can right click on a word to do a > similar search. Racket Users list: http://lists.racket-

Re: [racket] Documentation enhancement suggestions

2012-01-02 Thread Robby Findler
FWIW, in DrRacket, you can type f1 to search for the text that's at the current insertion point and you can right click on a word to do a similar search. The online check syntax makes it possible to jump right to the docs for a given imported variable. Robby On Mon, Jan 2, 2012 at 8:49 AM, Erich

Re: [racket] Documentation enhancement suggestions

2012-01-02 Thread Erich Rast
I personally have no quirks with the existing documentation, I think it's excellent. But here is another suggestion that I would find tremendously helpful: an auto-hover live help that pops up information about function definitions plus a short explanation of what the function does directly in the

Re: [racket] Documentation enhancement suggestions

2012-01-02 Thread Caner Derici
I don't like the idea of people solving "real world" problems copy/paste'ing code from docs, which I'm not sure it's even possible (e.g. what would be the example of call/cc?). However, couple of times I've been in a position to write some general usage examples of a function that we looked up in

[racket] Documentation enhancement suggestions

2012-01-01 Thread Gerry Weaver
Hello All, It seems we are not seeing many/any actual suggestions for ways to improve the Racket documentation. I have been thinking about this quite a bit. Writing good documentation is hard and very time consuming. It is also a task which most developers absolutely hate (myself included). I'v