I'm not sure you can generalize whether abbreviations are good or bad. It depends how obvious their meaning is. No one in favor of abreviations wants to replace say JSONResponseType (if such a name exists) with JRT! Nor does anyone want to replace JSON with JavaScriptObjectNotation. Everyone agrees it's not black and white and a balance is needed between verbosity, clarity, and conciseness. I propose that a this stage we try to vote and agree on as many black and white goals as possible, to create a list of guidelines. Resolving conflicts between guidelines maybe should wait until afterwards to establish conventions. This may be influenced by precedent as well as reason and discussion, and the conventions should then be used to help enforce consistency. For a black and white guideline, does anyone disagree with the following? "An abbreviation which is either commonly recognized or used commonly in Lift names, may be used as part of a name; otherwise it should not be." Again, of course it leaves plenty of gray area--that's on purpose; the gray area can later be addressed by "conventions."
------------------------------------- Jim Barrows<[email protected]> wrote: I snipped some stuff. On Mon, Dec 14, 2009 at 12:34 PM, David Pollak < [email protected]> wrote: > > > On Sun, Dec 13, 2009 at 10:39 PM, Heiko Seeberger < > [email protected]> wrote: > >> 2009/12/13 Kris Nuttycombe <[email protected]> >> 5) Avoid using abbreviations >> > > I disagree. When coding with a non-IDE, abbreviations make life much > easier. > I agree with David, abbreviations are better. When I'm trying to get something out of my head and into code, I don't want things getting in my way. 2 things in this scenario get in my way. 1) autocomplete is slow 2) typing is slow. Here's something else to think about on this issue. A good typist, familiar with their material can type faster then most code completions can operate. In studying data entry folks at UofP, I noticed something about the auto-complete functionality that wasn't obvious to me before. It's not how fast the code complete pops up that slow you down. It's the mental shift from typing to reading that takes the most time. You always have to verify that what the auto-complete is going to use is correct. This almost always takes more time then typing it yourself (assuming an expert typist). > >> >> >>> In general, the principle goal of this effort must be improving the >>> clarity of the Lift API for both new adopters and for maintainers. >> >> >> 100% agreed! >> >> In order to make Lift even more popular it is essential to ease adoption. >> Often folks require better documentation and we all know that the code (the >> API) is the first and best source of documentation. >> >> Heiko >> >> My job: weiglewilczek.com >> My blog: heikoseeberger.name >> Follow me: twitter.com/hseeberger >> OSGi on Scala: scalamodules.org >> Lift, the simply functional web framework: liftweb.net >> >> -- >> You received this message because you are subscribed to the Google Groups >> "Lift" group. >> To post to this group, send email to [email protected]. >> To unsubscribe from this group, send email to >> [email protected]<liftweb%[email protected]> >> . >> For more options, visit this group at >> http://groups.google.com/group/liftweb?hl=en. >> > > > > -- > Lift, the simply functional web framework http://liftweb.net > Beginning Scala http://www.apress.com/book/view/1430219890 > Follow me: http://twitter.com/dpp > Surf the harmonics > > -- > You received this message because you are subscribed to the Google Groups > "Lift" group. > > To post to this group, send email to [email protected]. > To unsubscribe from this group, send email to > [email protected]<liftweb%[email protected]> > . > For more options, visit this group at > http://groups.google.com/group/liftweb?hl=en. > -- James A Barrows -- You received this message because you are subscribed to the Google Groups "Lift" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/liftweb?hl=en. -- You received this message because you are subscribed to the Google Groups "Lift" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/liftweb?hl=en.
