On 20 Jun 2014, at 10:45, Sven Van Caekenberghe <s...@stfx.eu> wrote:
> I am a bit offended by the generalisations in your remarks, Kilon. It sounds > a bit like there is no documentation at all. > > There are several books, covering many of the high level aspects. > > There is lots of documentation in the image, many class comments are pretty > good, as are many method comments - even quite a lot of implementation > comments can be found. > > OK, there are some terrible parts as well, and some people seems to make a > sport out of _not_ writing any comments at all - please call them out > specifically, but don't generalise. Thant’s why we have to reject slices without commented classes :). Anyway I hope that red exclamation marks to their job. Uko > > I have spent a large amount of time documenting all code that I published as > well as writing separate high level documentation and tutorials for most of > it as well as for Pharo in general. I know many others who did the same. > > On 20 Jun 2014, at 10:10, Yuriy Tymchuk <yuriy.tymc...@me.com> wrote: > >> I have not worked with spec a lot, but I think that it’s nice in terms of >> comments, they are very helpful. Also lately I’ve worked with Roassal2 - no >> comments at all, but you can ask Alex for help :) >> >> Uko >> >> On 20 Jun 2014, at 10:06, kilon alios <kilon.al...@gmail.com> wrote: >> >>> yes good idea Damien , thank you. Right now I am working with Rubric >>> building a new workspace tool basing it on the rubric example. Spec and >>> Morphic are on my list too. >>> >>> Should I open also an issue on the bug tracker with a slice of my class >>> comment ? Or is posting it here enough ? >>> >>> >>> On Fri, Jun 20, 2014 at 10:47 AM, Damien Cassou <damien.cas...@gmail.com> >>> wrote: >>> >>> On Fri, Jun 20, 2014 at 9:10 AM, kilon alios <kilon.al...@gmail.com> wrote: >>> Saying that I will start adding class comments wherever I can but obviously >>> the people that have created the code are far more qualified than me . >>> >>> >>> I suggest that you ask on this mailing list when you would like to have >>> documentation on a class and you can't write it yourself. That way, we all >>> will read the answer. Hopefully, someone, will merge this and write a class >>> comment. >>> >>> >>> -- >>> Damien Cassou >>> http://damiencassou.seasidehosting.st >>> >>> "Success is the ability to go from one failure to another without losing >>> enthusiasm." >>> Winston Churchill >>> >> > >
