Tom-
Definitely helps, I'll add this on the next var update cycle.
Thanks, Zack.
On Jul 18, 12:17 pm, Tom Faulhaber wrote:
> What I've noticed is that conventions on doc string indentation is all
> over the place. Combine that with the fact that folks build tables and
> columns by hand, and a r
What I've noticed is that conventions on doc string indentation is all
over the place. Combine that with the fact that folks build tables and
columns by hand, and a really simplistic rule doesn't work so much.
I recommend you just grab the remove-leading-whitespace function from
the autodoc progra
Hi Zack,
I just had a look at ClojureDocs.org and it's really neat!
Some observations I made:
- When I view the docs of let's say clojure.set/rename, the clojure.set
part is a link. But instead of pointing to to clojure.set summary
page, it is only http:.
- In the source section, not all r
Islon- See the week 1 post on the CD.org group (http://
groups.google.com/group/clojuredocsorg/browse_thread/thread/
af7edbf85a6607c4) as to where this fits in on the timeline.
Lee- Very cool, I've added it to the UserVoice page.
Daniel- I agree, a great search experience is key for documentation
A few thoughts... It might be interesting to allow examples to be
rated. Quality or usefulness of the provided example could then be
inferred from the rating and highly rated examples could bubble to the
top or have the associated rating prominently shown.
~A
On Jul 16, 10:29 am, Lee Hinman wro
Hi Zack,
I just take a quick look at your site and must say that I'm impressed.
This is going to become one of the utilities I constantly keep open in
the background while developing. Especially since features like the
Var cross-referencing tend to make easier to get the "big picture".
One thing
Had another suggestion,
As an example contributor, It would be really nice to see a list of
functions that have no examples yet at a glance, so if I wanted to
work on adding examples I could go through a list and work on
functions that have no examples. I believe the clojure-examples
appspot wiki
Hi.
Does clojuredocs expose any external API (json, xml... rest,
webservices, etc) so I can access the docs from my code?
Islon
On Jul 13, 11:40 pm, j-g-faustus wrote:
> On Jul 13, 8:37 pm, Paul Moore wrote:
>
> > Can I suggest omitting the "Table of contents" sidebar when printing?
> > I've n
On Jul 13, 8:37 pm, Paul Moore wrote:
> Can I suggest omitting the "Table of contents" sidebar when printing?
> I've not tried printing the document to see how it looks, but removing
> the sidebar would be an essential starting point...
Why would anyone want to print it?
I occasionally print lon
On 11 July 2010 12:05, Lukasz Urbanek wrote:
> Looks very nice!
>
> Hoping for the categories to arrive to the core namespace. This really
> saves a lot of time for a clojure beginner like me.
+1
> Additionally, I'd prefer if the source was wasn't exposed by default
> (It's quite distracting whe
Hi,
Am 13.07.2010 um 14:26 schrieb j-g-faustus:
>>> I made my own cheat sheet for private use over the past month or so,
>>> core functions only. It's at the 80% stage, I don't expect it will
>>> ever be 100%, but I have found it useful:
>>> http://faustus.webatu.com/clj-quick-ref.html
Some comm
I agree. The in-code function documentation serves its purpose but
could be improved upon in a medium where space is at less of a
premium.
Bill Smith
Austin, TX
On Jul 10, 12:36 pm, James Reeves wrote:
> On 10 July 2010 15:06, Stuart Halloway wrote:
>
> > (6) Because docstrings are designed f
On 12 July 2010 23:25, j-g-faustus wrote:
> The site looks very nice, I especially like the "find real world
> examples" functionality and the fact that it collects documentation
> for common non-core libraries as well.
>
> I made my own cheat sheet for private use over the past month or so,
> cor
On 13 Jul, 01:28, j-g-faustus wrote:
> On Jul 13, 12:25 am, j-g-faustus wrote:
>
> > I made my own cheat sheet for private use over the past month or so,
> > core functions only. It's at the 80% stage, I don't expect it will
> > ever be 100%, but I have found it useful:
> > http://faustus.webatu.
On Jul 13, 12:25 am, j-g-faustus wrote:
> I made my own cheat sheet for private use over the past month or so,
> core functions only. It's at the 80% stage, I don't expect it will
> ever be 100%, but I have found it useful:
> http://faustus.webatu.com/clj-quick-ref.html
Looks like the hosting pro
The site looks very nice, I especially like the "find real world
examples" functionality and the fact that it collects documentation
for common non-core libraries as well.
I made my own cheat sheet for private use over the past month or so,
core functions only. It's at the 80% stage, I don't expec
On Sun, Jul 11, 2010 at 4:10 PM, zkim wrote:
> If you're willing to continue the discussion, I'd like to keep this
> going (maybe another thread?). As I'm writing this I'm getting the
> feeling that I'm not quite articulating my thoughts well, and I think
> further discussion will help me to fles
As a Clojure novice I'm happy to see the documentation side of the
Clojure ecosystem growing regardless of the stack used for a doc site.
Having a resource like a user-edited php.net will be a great help. I
am excited about submitting a few examples of my own.
On Jul 11, 9:14 am, Phil Hagelberg w
We use Rails for all our GUIs,
we need simple CRUD most of
the time and we ActiveScaffold.
Most of our controllers are less than
70 lines and we seldom write forms.
We use the ActiveScaffold partial
forms almost every were sometimes
custpmizing them.
Clojure Web Frameworks are not
there yet.
We
Rich-
> It sounded to me like he was only saying that he's more familiar with
> Ruby/Rails than he is with Clojure.
Correct. I think it was a fair question, and I'm happy to provide
insights into my decision making process.
-Zack
On Jul 11, 12:37 pm, Richard Lyman wrote:
> On Sun, Jul 11, 201
Lukasz-
> Hoping for the categories to arrive to the core namespace. This really
> saves a lot of time for a clojure beginner like me.
The way Justin did this is great (http://clojure-examples.appspot.com/
clojure.core). I'm hoping to add this in the near future.
> Additionally, I'd prefer if th
Phil-
A little background on my clojure web experience: I've got a intranet
web tool written using ring / enlive / moustache (system health /
monitoring for a personal project) as well as dabbled in compojure
before the 0.4.0 rev, and more recently I've been looking at sandbar /
carte. The timefra
On Sun, Jul 11, 2010 at 8:14 AM, Phil Hagelberg wrote:
> On Sat, Jul 10, 2010 at 11:23 PM, zkim wrote:
>>> but what do you think about using Justin's codebase, or an Aleph-based
>>> server to
>>> host the thing instead of Ruby/Rails? (see the link above for more details)
>>
>> I'm inclined to mo
Looks very nice!
Hoping for the categories to arrive to the core namespace. This really
saves a lot of time for a clojure beginner like me.
Additionally, I'd prefer if the source was wasn't exposed by default
(It's quite distracting when one is looking for the examples), some
kind of "source" but
On Sat, Jul 10, 2010 at 11:23 PM, zkim wrote:
>> but what do you think about using Justin's codebase, or an Aleph-based
>> server to
>> host the thing instead of Ruby/Rails? (see the link above for more details)
>
> I'm inclined to move forward with the Ruby / Rails for now. The
> reason I went
Stu-
> (2) +1 on hiding private APIs. We use private APIs carefully and
> deliberately in Clojure, and I would hate to facilitate people
> writing code that will break later.
That's +4 on this one by my tally, I'll pull the private vars.
> (3) +1 on making it very easy to see which version of a
Shantanu-
> One suggestion -- consider providing a downloadable
> bundle for offline use as well.
I believe there's an item up on the UserVoice page (http://
clojuredocs.uservoice.com/) keep an eye out for updates and comments
there.
-Zack
On Jul 10, 3:29 am, Shantanu Kumar wrote:
> This is g
Heinz-
> first of all, great effort there :) having a place for clojure docs is
> awesome.
Thanks, appreciated.
> 1) http://github.com/defn/walton - have a look at it, it might be a
> good way to fetch examples for functions where none are provided yet.
I'll take a look.
> 2) Will it be po
Greg-
I'd like to take the time to look over the post you linked in-depth
before responding.
> but what do you think about using Justin's codebase, or an Aleph-based server
> to
> host the thing instead of Ruby/Rails? (see the link above for more details)
I'm inclined to move forward with the R
> http://gist.github.com/470031
>
> I'm sure something like it could be made for ClojureDocs.org once the
> API is in place.
Nice, looks pretty straightforward.
> I think an important aspect of a
> collaborative tool like this is quality control. To that end, a
> complete list of recent updates
Zack if you need help with this Rail
app let us now. We can give you a
hand, the wish list keeps growing :)))
Luc P.
Sent from my iPod
On 2010-07-09, at 15:07, zkim wrote:
Hi Justin, thanks again for the go-ahead to pull examples from
http://clojure-examples.appspot.com.
Zack, you had me
On 10 July 2010 15:06, Stuart Halloway wrote:
> (6) Because docstrings are designed for consumption at a REPL, they may in
> some cases presume a fixed font. Worth considering for display on the site.
What about giving function documentation the same "wiki" behaviour
that the examples have? Star
Very cool. Let me start by saying thanks to everyone who has been involved in
the various threads on improving documentation, especially those who, like
Zack, have taken substantial action.
Here are a bunch of ideas, in no particular order:
(1) Ease of contribution is huge, and http://clojuredo
On 9 July 2010 21:06, Tom Faulhaber wrote:
> Quick thought: You probably don't want to include private vars.
Seconded. It's a little confusing seeing private vars and macros in
the API docs!
Other than that, this looks excellent. I'm signing up as I write this.
- James
--
You received this me
This is GREAT!!! I love the way you have opened it up for community
participation.
Robert
On Jul 9, 4:32 am, zkim wrote:
> Hi All,
>
> I'll try to keep this short.
>
> I've gotten a lot out of Clojure: I can honestly say that learning
> this language, and being part of this community has made m
This is great. One suggestion -- consider providing a downloadable
bundle for offline use as well.
Regards,
Shantanu
On Jul 10, 2:11 pm, "Heinz N. Gies" wrote:
> Hi Zack,
> first of all, great effort there :) having a place for clojure docs is
> awesome. Two things come to mind:
>
> 1)http://gi
Hi Zack,
first of all, great effort there :) having a place for clojure docs is awesome.
Two things come to mind:
1) http://github.com/defn/walton - have a look at it, it might be a good way to
fetch examples for functions where none are provided yet.
2) Will it be possible to put other 3rd par
Hi,
Am 09.07.2010 um 23:47 schrieb zkim:
> I kind of went back and forth on this. Originally I only parsed out
> public vars, but in a couple of instances I found that when tracing
> through some code I would hit on private vars.
I'm suspicious of showing source code to the reader with everythi
*argh*. well at least my email is now finally on the whitelist.
What do you guys think of some of the ideas presented in the "Solving Clojure's
Documentation Problem Without Fragmentation" thread? (Which I sent shortly
after this thread started, but ended up being posted several hours later).
h
An "examples" function for the REPL that pulls from the wiki:
http://gist.github.com/470031
I'm sure something like it could be made for ClojureDocs.org once the
API is in place.
General comments on ClojureDocs.org: I think an important aspect of a
collaborative tool like this is quality control
Tom-
I kind of went back and forth on this. Originally I only parsed out
public vars, but in a couple of instances I found that when tracing
through some code I would hit on private vars.
Perhaps a solution where private vars are hidden from normal flow
(browsing and searching) unless explicitly
Beautiful. I think this should become the official community place for
Clojure docs. Now who wants to integrate my :examples defn attribute
code :)
-John
On Jul 9, 4:32 am, zkim wrote:
> Hi All,
>
> I'll try to keep this short.
>
> I've gotten a lot out of Clojure: I can honestly say that learni
On 9 July 2010 09:32, zkim wrote:
>
> Questions / thoughts?
>
>
Looks really good to me. Could you display the version numbers for Clojure
and the libraries that the site covers?
Gavin
--
You received this message because you are subscribed to the Google
Groups "Clojure" group.
To post to thi
Hi Justin, thanks again for the go-ahead to pull examples from
http://clojure-examples.appspot.com.
> Zack, you had mentioned you planned to keep the source of your site
> proprietary -- is that set in stone?
Definitely not set in stone. As far as the site goes there's not much
Clojure going on
I've put these suggestions up on the UserVoice page, I believe I got
all of them, but if I missed yours please add it yourself or let me
know.
Dimitri: I share your frustrations with having to remember yet another
login / password. Other than minor cosmetic fixes, improving the user
signup / login
Thanks all for your kind words. As to the specifics:
> The headers for each section (Doc, Source, Example(s)) don't
> differentiate themselves from the regular doc text enough, maybe
> bold/underline/color them to make them show up more?
I'd agree, I think the visual styling of the page will cha
On Fri, Jul 9, 2010 at 2:32 AM, zkim wrote:
> Hi All,
>
> Questions / thoughts?
>
> -Zack
Hi Zack,
First off, I think it looks great, and it definitely seems useful when
trying to find an example of a particular API call.
Few suggestions:
1. The headers for each section (Doc, Source, Example(s))
Quick thought: You probably don't want to include private vars.
On Jul 9, 1:32 am, zkim wrote:
> Hi All,
>
> I'll try to keep this short.
>
> I've gotten a lot out of Clojure: I can honestly say that learning
> this language, and being part of this community has made me a better,
> happier develo
I've told Zack that he is free to pull any examples from the wiki for
use on his site.
I don't know about collaboration beyond that. The wiki is open source
and written in Clojure; anyone is free to contribute/fork. At least
one person has expressed interest in making code contributions.
Zack, yo
I've actually been thinking about this exact same kind of site for a
while now and I'm thrilled that I was too lazy to do it so that you
could do it instead. :)
One idea that I have that I think would be killer would be to provide
an API to look up one your examples at the repl so I could do
somet
It's a great idea, and the site looks very good.
Two suggestions:
1. Move examples section above source code section
2. Add OpenID sign in support. Personally I'm instantly repelled by
sites asking me to create another account/password. And I'm sure I'm
not alone. Stackoverflow.com is a great examp
Having contributed a lot of examples to clojure-examples.appspot.com
this week, I agree that it would be a shame to duplicate efforts.
On Jul 9, 11:21 am, David Nolen wrote:
> On Fri, Jul 9, 2010 at 4:32 AM, zkim wrote:
>
> > Questions / thoughts?
>
> > -Zack
>
> This is great. I think the main
On Fri, Jul 9, 2010 at 4:32 AM, zkim wrote:
>
> Questions / thoughts?
>
> -Zack
This is great. I think the main thing is not duplicating effort. This and
clojure-examples.appspot.com should really join forces.
David
--
You received this message because you are subscribed to the Google
Groups
On Fri, Jul 9, 2010 at 2:32 AM, zkim wrote:
> Hi All,
>
> Questions / thoughts?
>
> -Zack
Hi Zack,
First off, I think it looks great, and it definitely seems useful when
trying to find an example of a particular API call.
Few suggestions:
1. The headers for each section (Doc, Source, Example(s))
I took a first look and I have to say that the idea is genius and I love
what you put up together this far.
It is difficult to keep up with what's happening in the Clojure world, and
this kind of central place to keep track of things was needed. The examples
are also a strong point.
I hope the site
55 matches
Mail list logo
