Re: [Pharo-dev] Default package comment

2015-05-19 Thread Christophe Demarey
Le 18 mai 2015 à 15:17, Sergio Fedi a écrit : Personally, I do not fear to change the comment implementation later. That's what Smalltalk is good at. +1. But the most difficult thing is not to change the implementation but all its usage. if people start to use a feature and you

Re: [Pharo-dev] Default package comment

2015-05-19 Thread Christophe Demarey
Le 19 mai 2015 à 16:03, Sergio Fedi a écrit : DolphinPackageBrowser.png ​ Top left pane: File system tree where packages are located Down left pane: Packages in the file system location selected above Tabs: Comment - Whatever text you put Classes - Classes defined by the package Loose

Re: [Pharo-dev] Default package comment

2015-05-18 Thread Sergio Fedi
Personally, I do not fear to change the comment implementation later. That's what Smalltalk is good at. +1. But the most difficult thing is not to change the implementation but all its usage. if people start to use a feature and you change the way to use it after, it is more difficult to

Re: [Pharo-dev] Default package comment

2015-05-18 Thread Christophe Demarey
Le 15 mai 2015 à 22:39, Sergio Fedi a écrit : Personally, I do not fear to change the comment implementation later. That's what Smalltalk is good at. +1. But the most difficult thing is not to change the implementation but all its usage. if people start to use a feature and you change the

Re: [Pharo-dev] Default package comment

2015-05-15 Thread Sergio Fedi
Ok, I came up with this default comment. Let's see what you guys think of it: *This is a default comment for a package.* *To create a new one follow these guidelines:* * - Make the first line a one line description of the package and its purpose.* * - Describe with a more detailed description

Re: [Pharo-dev] Default package comment

2015-05-15 Thread Sean P. DeNigris
Sergio Fedi wrote Let's see what you guys think of it: Why not?! I'm sure we'll tweak it as we start using it. The only thing is that maybe specific meta info like author, contact, website, repository, and date of creation should go in separate methods so that they can be dealt with

Re: [Pharo-dev] Default package comment

2015-05-15 Thread Eliot Miranda
On Fri, May 15, 2015 at 9:40 AM, Sergio Fedi sergio.f...@gmail.com wrote: I would add: - describe how to load the package, including any additional dependencies, version requirements, etc. Even though to read the comment you have to already have done all of that? I expect a package

Re: [Pharo-dev] Default package comment

2015-05-15 Thread Sergio Fedi
Personally, I do not fear to change the comment implementation later. That's what Smalltalk is good at. But that doesn't mean it's the right choice :) The thing is that we can go full speed with this and make comments for: oneLineSummary longDescription usageDescription preInstallComment

Re: [Pharo-dev] Default package comment

2015-05-15 Thread Sean P. DeNigris
Sergio Fedi wrote But for now, until the author and other data is not in differente methods, don't you think it's better to have it in the comment rather than nowhere else? You're inventing it, why not invent it as meta-data. At the start of something, there is a unique opportunity because no

[Pharo-dev] Default package comment

2015-05-14 Thread Sergio Fedi
Hi guys, we are adding comments to packages and we would like a feedback from the community. What do you suggest for the default package comment?