Re: New version of API tool up

Inline...

On 10/30/06, Alex Russell <alex@xxxxxxxxxxxxxxx> wrote:

I realize I'm late to this part but...

On Tuesday 24 October 2006 6:53 am, Tom Trenka wrote:
> Inline as a wake up (meaning before my first cup of joe)...
>

> OK.  In some ways then I was wrong to name the methods in Plotters as
> proper-cased...*but*...that's a style *guide*.  Which we are supposed
> to follow, true.  But I can tell you for sure that there is a whole
> body of people who have different ideas about what's right and
> wrong--and in particular, I'm thinking of the .NET crowd, who
> ProperCase everything.
>
> I think we need to figure out a better way of determining what a
> constructor is, and I have a feeling this is more Neil's area than
> Owen's.  I would actually prefer that we were explicit about it in
> the doc comments; it seems to me that we avoid a lot of different
> issues if we were to do something like that.

We're in a dynamic language. We don't get garuntees, and frankly if
folks don't agree with our style guide, they won't (and shouldn't) be
adding code to Dojo. When in Rome and all that.

Lastly, the whole point of the doc tool vs. other available options has
always been that we can avoid writing everything twice. The whole DRY
thing is the reason we did this, and going back on it for soemthing
where convention is enough to disambiguate seems...strange.

Only if you consider the doc tool to be a Dojo-specific doc tool--and my understanding (talking quite a bit with Neil, etc.) is that was never really the case.   As far as the style guide goes, there will always be situations where there are conflicting ideas or rules that we're going to run into no matter what (and the Plotter is an excellent example of this).  I don't know that I agree that convention is *always* enough to disambiguate, which is why I suggested that we add an additional, optional hinting comment, details TBD.

trt

_______________________________________________
dojo-contributors mailing list
dojo-contributors@xxxxxxxxxxxxxxx
http://dojotoolkit.org/mailman/listinfo/dojo-contributors