DIP guidelines [was: DIP6: Attributes]

Leandro Lucarella llucax at gmail.com
Sun Aug 2 11:06:36 PDT 2009


Ary Borenszweig, el  2 de agosto a las 00:07 me escribiste:
> Leandro Lucarella escribió:
> >Ary Borenszweig, el  1 de agosto a las 16:29 me escribiste:
> >>http://www.prowiki.org/wiki4d/wiki.cgi?LanguageDevel/DIPs/DIP6
> >Please, try to post at least the abstract of the DIP with the link, so
> >people can easily know what is it about =)
> >And when writing a DIP, try to make the abstract a little more
> >descriptive. From an abstract you should be able to tell what the DIP is
> >about (in this case explain what an annotation is at least). A oneliner is
> >not good enough, that's just a title, not an abstract. If it's too hard
> >to explain, try to provide a link to somewhere else where the terms are
> >described.
> >The rationale can be a little more descriptive too. What are the
> >advantages of removing keywords for example? Use NG posts links if you
> >have some problems documented there, for example.
> >Try not to explain your opinion in DIPs. They are not NG posts, they
> >should provide facts and be as objective as possible. Even when that's
> >pretty hard, saying "I prefer Java's one because ..." is excessively
> >subjective. Avoid doing that. You can express the same by saying something
> >like "Java syntax has the advantage of ..." for example.
> >A section called "Other thoughts" is not very serious either. If you are
> >not yet convinced about something in the DIP, post it in the announcement
> >post in the NG so it can be discussed and added later to the DIP when the
> >idea is in better shape.
> >Please, don't take this personally, I just want DIPs to be high quality,
> >otherwise they will never be taken seriously. =)
> >I've added this information in a Recommendations subsection to the DIP1,
> >see:
> >http://www.prowiki.org/wiki4d/wiki.cgi?LanguageDevel/DIPs/DIP1#Recommendations
> >I'll address the DIP itself in another post ;)
> 
> Hola Leandro,
> 
> I've updated the DIP page with your recommendations. I agree with all of
> them.

Thanks!

-- 
Leandro Lucarella (luca) | Blog colectivo: http://www.mazziblog.com.ar/blog/
----------------------------------------------------------------------------
GPG Key: 5F5A8D05 (F8CD F9A7 BF00 5431 4145  104C 949E BFB6 5F5A 8D05)
----------------------------------------------------------------------------
"Somos testigos de Jaimito, venimos a traer la salvación, el mundo va a
desaparecer, somos testigos de Jaimito!". Nos enyoguizamos... Así que
"somos testigos"? Te dejo el culo hecho un vino, y la conch'itumá, y la
conch'itumá!
	-- Sidharta Kiwi



More information about the Digitalmars-d mailing list