cmpilato@collab.net writes:
> > If you're depending on a certain behavior from dir_deltas, and that
> > behavior can't be discovered from its doc string, than the doc needs
> > to be fixed.
>
> In this case, all is well. Ben's depending on dir_deltas driving an
> editor to convert one dir into another. And it does. Just like the
> docstring says it will.
Mmmm, but it sounds like Ben needs to know more than just "driving an
editor". He wants to know in what order certain editor operations
(adds and deletes?) will happen over a given directory baton, and
nothing in the editor spec itself forces a particular order.
Therefore, the driver's documentation would have to say.
Almost by definition, if one needs to know something about a
function's behavior, and can't figure it out from the docstring, then
the docstring needs to say more.
That's what's going on here, right? (Or am I misunderstanding Ben?)
[Note, in case it wasn't clear: none of this is a criticism of the
dir_deltas doc string. It's fine to start out with a certain level of
detail, and then refine on demand.]
-K
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Sat Oct 21 14:37:03 2006