You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@subversion.apache.org by Edmund Wong <ed...@kdtc.net> on 2009/04/17 02:08:50 UTC

svn_wc_parse_externals_description3 docstring

Hi,

I'm having some difficulty understanding the following docstring
(for the subjected function):

  "* The format of @a desc is the same as for values of the directory
   * property @c SVN_PROP_EXTERNALS, which see."

I don't understand that last part, "which see".

Can someone tell me what I'm missing because to me it's missing
something as it is?

Thanks

Edmund

------------------------------------------------------
http://subversion.tigris.org/ds/viewMessage.do?dsForumId=462&dsMessageId=1758968

Re: svn_wc_parse_externals_description3 docstring

Posted by "Hyrum K. Wright" <hy...@mail.utexas.edu>.
On Apr 17, 2009, at 9:45 AM, C. Michael Pilato wrote:

> Greg Stein wrote:
>> On Fri, Apr 17, 2009 at 15:27, C. Michael Pilato  
>> <cm...@collab.net> wrote:
>>> Edmund Wong wrote:
>>>> Hi,
>>>>
>>>> I'm having some difficulty understanding the following docstring
>>>> (for the subjected function):
>>>>
>>>>  "* The format of @a desc is the same as for values of the  
>>>> directory
>>>>   * property @c SVN_PROP_EXTERNALS, which see."
>>>>
>>>> I don't understand that last part, "which see".
>>> "which see" is something like "which you should go read for more  
>>> information".
>>
>> Eh? It's just plain bad grammar. Probably somebody just forgot to
>> finish writing that sentence.
>
> No ... no ... It's a Karl-ism, I'm pretty sure, and "bad grammar"  
> ain't
> really his M.O.

Plus, I like the ambiance the olde English feel gives to the  
project.  :P

-Hyrum

------------------------------------------------------
http://subversion.tigris.org/ds/viewMessage.do?dsForumId=462&dsMessageId=1768909

Re: svn_wc_parse_externals_description3 docstring

Posted by Stefan Sperling <st...@elego.de>.
On Fri, Apr 17, 2009 at 11:03:04PM +0800, Edmund Wong wrote:
> C. Michael Pilato wrote:
> 
> >>>> I don't understand that last part, "which see".
> >>> "which see" is something like "which you should go read for more information".
> >> Eh? It's just plain bad grammar. Probably somebody just forgot to
> >> finish writing that sentence.
> > 
> > No ... no ... It's a Karl-ism, I'm pretty sure, and "bad grammar" ain't
> > really his M.O.
> > 
> 
> Karl-ism?

He meant Karl Fogel. Karl has published books. Karl has good grammer skills.

Stefan

Re: svn_wc_parse_externals_description3 docstring

Posted by Edmund Wong <ed...@kdtc.net>.
C. Michael Pilato wrote:

>>>> I don't understand that last part, "which see".
>>> "which see" is something like "which you should go read for more information".
>> Eh? It's just plain bad grammar. Probably somebody just forgot to
>> finish writing that sentence.
> 
> No ... no ... It's a Karl-ism, I'm pretty sure, and "bad grammar" ain't
> really his M.O.
> 

Karl-ism?

Edmund

------------------------------------------------------
http://subversion.tigris.org/ds/viewMessage.do?dsForumId=462&dsMessageId=1769067

Re: svn_wc_parse_externals_description3 docstring

Posted by Stefan Sperling <st...@elego.de>.
On Fri, Apr 17, 2009 at 11:15:34AM -0400, C. Michael Pilato wrote:
> You'd prefer:
>    The format of @a desc is the same as for values of the directory
>    property @c SVN_PROP_EXTERNALS, which see for a description of
>    the format that is the same as that of @a desc.

I think he'd prefer:

   The format of @a desc is the same as for values of the directory
   property @c SVN_PROP_EXTERNALS, which see for a description of
   the format that is the same as for values of the directory
   property @c SVN_PROP_EXTERNALS, which see for a description of
   the format that is the same as for values of the directory
   property @c SVN_PROP_EXTERNALS, ...

SCNR

Stefan

Re: svn_wc_parse_externals_description3 docstring

Posted by "C. Michael Pilato" <cm...@collab.net>.
Greg Stein wrote:
> On Fri, Apr 17, 2009 at 16:48, C. Michael Pilato <cm...@collab.net> wrote:
>> C. Michael Pilato wrote:
>>> Greg Stein wrote:
>>>> On Fri, Apr 17, 2009 at 15:27, C. Michael Pilato <cm...@collab.net> wrote:
>>>>> Edmund Wong wrote:
>>>>>> Hi,
>>>>>>
>>>>>> I'm having some difficulty understanding the following docstring
>>>>>> (for the subjected function):
>>>>>>
>>>>>>   "* The format of @a desc is the same as for values of the directory
>>>>>>    * property @c SVN_PROP_EXTERNALS, which see."
>>>>>>
>>>>>> I don't understand that last part, "which see".
>>>>> "which see" is something like "which you should go read for more information".
>>>> Eh? It's just plain bad grammar. Probably somebody just forgot to
>>>> finish writing that sentence.
>>> No ... no ... It's a Karl-ism, I'm pretty sure, and "bad grammar" ain't
>>> really his M.O.
>> A Google search for "which see for more" -- which see for details :-) --
>> pulls up no shortage of instances of this grammar form.
> 
> Name one.
> 
> Every one that I see has something that comes after it. As in "see WHAT".
> 
> I'm not buying that that is good grammar.

What you find is "which see for more information" or "which see for
details".  In the generic sense, you find "which see WHY".  But WHY is
optional, and in the use above, is implied by the surrounding context.
You'd prefer:

   The format of @a desc is the same as for values of the directory
   property @c SVN_PROP_EXTERNALS, which see for a description of
   the format that is the same as that of @a desc.

?

:-P

(I plan not to contribute more mails to this thread.)

-- 
C. Michael Pilato <cm...@collab.net>
CollabNet   <>   www.collab.net   <>   Distributed Development On Demand

------------------------------------------------------
http://subversion.tigris.org/ds/viewMessage.do?dsForumId=462&dsMessageId=1769329

Re: svn_wc_parse_externals_description3 docstring

Posted by Greg Stein <gs...@gmail.com>.
On Fri, Apr 17, 2009 at 16:48, C. Michael Pilato <cm...@collab.net> wrote:
> C. Michael Pilato wrote:
>> Greg Stein wrote:
>>> On Fri, Apr 17, 2009 at 15:27, C. Michael Pilato <cm...@collab.net> wrote:
>>>> Edmund Wong wrote:
>>>>> Hi,
>>>>>
>>>>> I'm having some difficulty understanding the following docstring
>>>>> (for the subjected function):
>>>>>
>>>>>   "* The format of @a desc is the same as for values of the directory
>>>>>    * property @c SVN_PROP_EXTERNALS, which see."
>>>>>
>>>>> I don't understand that last part, "which see".
>>>> "which see" is something like "which you should go read for more information".
>>> Eh? It's just plain bad grammar. Probably somebody just forgot to
>>> finish writing that sentence.
>>
>> No ... no ... It's a Karl-ism, I'm pretty sure, and "bad grammar" ain't
>> really his M.O.
>
> A Google search for "which see for more" -- which see for details :-) --
> pulls up no shortage of instances of this grammar form.

Name one.

Every one that I see has something that comes after it. As in "see WHAT".

I'm not buying that that is good grammar.

Cheers,
-g

------------------------------------------------------
http://subversion.tigris.org/ds/viewMessage.do?dsForumId=462&dsMessageId=1769183


Re: svn_wc_parse_externals_description3 docstring

Posted by "C. Michael Pilato" <cm...@collab.net>.
C. Michael Pilato wrote:
> Greg Stein wrote:
>> On Fri, Apr 17, 2009 at 15:27, C. Michael Pilato <cm...@collab.net> wrote:
>>> Edmund Wong wrote:
>>>> Hi,
>>>>
>>>> I'm having some difficulty understanding the following docstring
>>>> (for the subjected function):
>>>>
>>>>   "* The format of @a desc is the same as for values of the directory
>>>>    * property @c SVN_PROP_EXTERNALS, which see."
>>>>
>>>> I don't understand that last part, "which see".
>>> "which see" is something like "which you should go read for more information".
>> Eh? It's just plain bad grammar. Probably somebody just forgot to
>> finish writing that sentence.
> 
> No ... no ... It's a Karl-ism, I'm pretty sure, and "bad grammar" ain't
> really his M.O.

A Google search for "which see for more" -- which see for details :-) --
pulls up no shortage of instances of this grammar form.

-- 
C. Michael Pilato <cm...@collab.net>
CollabNet   <>   www.collab.net   <>   Distributed Development On Demand

------------------------------------------------------
http://subversion.tigris.org/ds/viewMessage.do?dsForumId=462&dsMessageId=1768898

Re: svn_wc_parse_externals_description3 docstring

Posted by "C. Michael Pilato" <cm...@collab.net>.
Greg Stein wrote:
> On Fri, Apr 17, 2009 at 15:27, C. Michael Pilato <cm...@collab.net> wrote:
>> Edmund Wong wrote:
>>> Hi,
>>>
>>> I'm having some difficulty understanding the following docstring
>>> (for the subjected function):
>>>
>>>   "* The format of @a desc is the same as for values of the directory
>>>    * property @c SVN_PROP_EXTERNALS, which see."
>>>
>>> I don't understand that last part, "which see".
>> "which see" is something like "which you should go read for more information".
> 
> Eh? It's just plain bad grammar. Probably somebody just forgot to
> finish writing that sentence.

No ... no ... It's a Karl-ism, I'm pretty sure, and "bad grammar" ain't
really his M.O.

-- 
C. Michael Pilato <cm...@collab.net>
CollabNet   <>   www.collab.net   <>   Distributed Development On Demand

------------------------------------------------------
http://subversion.tigris.org/ds/viewMessage.do?dsForumId=462&dsMessageId=1768803

Re: svn_wc_parse_externals_description3 docstring

Posted by Edmund Wong <ed...@kdtc.net>.
Greg Stein wrote:
> On Fri, Apr 17, 2009 at 15:27, C. Michael Pilato <cm...@collab.net> wrote:
>> Edmund Wong wrote:
>>> Hi,
>>>
>>> I'm having some difficulty understanding the following docstring
>>> (for the subjected function):
>>>
>>>   "* The format of @a desc is the same as for values of the directory
>>>    * property @c SVN_PROP_EXTERNALS, which see."
>>>
>>> I don't understand that last part, "which see".
>> "which see" is something like "which you should go read for more information".
> 
> Eh? It's just plain bad grammar. Probably somebody just forgot to
> finish writing that sentence.

Well, that's what my initial thoughts were.  With Michael's
explanation, I chalk it up to svn lingo and that I need more
exposure to the comments.

Edmund

------------------------------------------------------
http://subversion.tigris.org/ds/viewMessage.do?dsForumId=462&dsMessageId=1768893

Re: svn_wc_parse_externals_description3 docstring

Posted by Edmund Wong <ed...@kdtc.net>.
Philip Martin wrote:

>>> "which see" is something like "which you should go read for more information".
>> Eh? It's just plain bad grammar. Probably somebody just forgot to
>> finish writing that sentence.
> 
> No, it's complete.  It's the English translation of the Latin term
> "quod vide".  The abbreviation "q.v." would be more conventional; I
> don't know if non-native English speakers would find that easier to
> understand.
> 

'quod vide" sounds nicer and more 'sophisticated', if that is what
the aim is in the docstrings. 'which see', even if it is
technically valid, still gives me the impression that someone
forgot what he/she was writing.  In any event, it's been adjusted
in revision 37328.

Edmund

------------------------------------------------------
http://subversion.tigris.org/ds/viewMessage.do?dsForumId=462&dsMessageId=1778461

Re: svn_wc_parse_externals_description3 docstring

Posted by Philip Martin <ph...@codematters.co.uk>.
Greg Stein <gs...@gmail.com> writes:

> On Fri, Apr 17, 2009 at 15:27, C. Michael Pilato <cm...@collab.net> wrote:
>> Edmund Wong wrote:
>>>
>>>   "* The format of @a desc is the same as for values of the directory
>>>    * property @c SVN_PROP_EXTERNALS, which see."
>>>
>>> I don't understand that last part, "which see".
>>
>> "which see" is something like "which you should go read for more information".
>
> Eh? It's just plain bad grammar. Probably somebody just forgot to
> finish writing that sentence.

No, it's complete.  It's the English translation of the Latin term
"quod vide".  The abbreviation "q.v." would be more conventional; I
don't know if non-native English speakers would find that easier to
understand.

------------------------------------------------------
http://subversion.tigris.org/ds/viewMessage.do?dsForumId=462&dsMessageId=1770039


Re: svn_wc_parse_externals_description3 docstring

Posted by Greg Stein <gs...@gmail.com>.
On Fri, Apr 17, 2009 at 15:27, C. Michael Pilato <cm...@collab.net> wrote:
> Edmund Wong wrote:
>> Hi,
>>
>> I'm having some difficulty understanding the following docstring
>> (for the subjected function):
>>
>>   "* The format of @a desc is the same as for values of the directory
>>    * property @c SVN_PROP_EXTERNALS, which see."
>>
>> I don't understand that last part, "which see".
>
> "which see" is something like "which you should go read for more information".

Eh? It's just plain bad grammar. Probably somebody just forgot to
finish writing that sentence.

Cheers,
-g

------------------------------------------------------
http://subversion.tigris.org/ds/viewMessage.do?dsForumId=462&dsMessageId=1768613


Re: svn_wc_parse_externals_description3 docstring

Posted by "C. Michael Pilato" <cm...@collab.net>.
Edmund Wong wrote:
> Hi,
> 
> I'm having some difficulty understanding the following docstring
> (for the subjected function):
> 
>   "* The format of @a desc is the same as for values of the directory
>    * property @c SVN_PROP_EXTERNALS, which see."
> 
> I don't understand that last part, "which see".

"which see" is something like "which you should go read for more information".

-- 
C. Michael Pilato <cm...@collab.net>
CollabNet   <>   www.collab.net   <>   Distributed Development On Demand

------------------------------------------------------
http://subversion.tigris.org/ds/viewMessage.do?dsForumId=462&dsMessageId=1767775