[squeak-dev] How may I contribute in documenting classes ?

dimitris chloupis thekilon at yahoo.co.uk
Sat Aug 18 07:32:47 UTC 2012


Sorry for the initial quotes I used one of my previous posts as a template and forgot to delete it. Of course my question still stands ;)

________________________________
 From: dimitris chloupis <thekilon at yahoo.co.uk>
To: The general-purpose Squeak developers list <squeak-dev at lists.squeakfoundation.org> 
Sent: Saturday, 18 August 2012, 10:29
Subject: [squeak-dev] How may I contribute in documenting classes ?
 

I am using squeak, I am learning it and I am loving it. I know its not perfect, I know it has it faults , but I feel I finally found an enviroment that I can do what I always want "live coding" 

As you can imagine as a begineer I spent a lot of time in system browser and I am suprised by the lack of documentation to some basic classes. Now I am probably the last person to qualify as a person to document those classes since my experience is very limited with Squeak and smalltalk.  But I feel that some documentation even if its a partial one , is better than no documentation. And since I am already reading so much of the souce , why not save people's time and mine (I can foget easily the code I read and so a documentation string can help me remember) by adding documentation strings to classes and their methods. 

The only things I dont know is how to make those documentations port back to squeak standard distribution. I assume would need some commit rights to the squeak source ? 


________________________________
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.squeakfoundation.org/pipermail/squeak-dev/attachments/20120818/def8f3e6/attachment.htm


More information about the Squeak-dev mailing list