Re: svn commit: r17535 - trunk/subversion/include

On Sun, Nov 27, 2005 at 02:34:06PM -0600, dionisos@tigris.org wrote:
> +++ trunk/subversion/include/svn_subst.h Sun Nov 27 14:34:04 2005
> @@ -355,8 +358,9 @@
> svn_boolean_t expand,
> apr_pool_t *pool);
>
> -/** Convenience routine (wrapper around svn_subst_copy_and_translate3)
> - * which detranslates the given @a src into @a dst.
> +/**
> + * Translates a file @a src in working copy form to a file @a dst in
> + * normal form form.

Extra 'form'. Didn't Julian mention that?

> +++ trunk/subversion/include/svn_wc.h Sun Nov 27 14:34:04 2005
> @@ -64,10 +64,24 @@
> + /** Translate from Normal Form.
> + *
> + * The working copy text bases and repository files are stored
> + * in normal form.

Ok.

> Some files' contents - or ever representation -
> + * differs between the working copy and the normal form.

There's something wrong with that sentence. I'm not sure quite what
it's trying to say.

> This flag
> + * specifies to take the latter form as input and transform it
> + * to the former.

'This flag specifies' is an odd phrasing. Moreover, 'latter' and
'former', while well-defined, are a bit awkward to read. How about just
dropping this sentence and expanding the brief summary to something like
"Translate from normal form to working copy form."?

Regards,
Malcolm

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Sun Nov 27 23:19:12 2005