[PATCH 5 of 5 RFC] document the peer interface

[Sune Foldager]

On 2012-06-30 14:41, Greg Ward wrote:
>On 26 June 2012, Sune Foldager said:
>> # HG changeset patch
>> # User Sune Foldager <cryo at cyanite.org>
>> # Date 1315233463 -7200
>> # Node ID 07d0858c3f870d7c29838dd86a06836f7f767e54
>> # Parent  7cbe7adbd271ec127e70e7ffb9cb062384ed0596
>> document the peer interface
>>
>> diff -r 7cbe7adbd271 -r 07d0858c3f87 mercurial/peer.py
>> --- a/mercurial/peer.py	Fri Sep 02 15:51:16 2011 +0200
>> +++ b/mercurial/peer.py	Mon Sep 05 16:37:43 2011 +0200
>> @@ -10,6 +10,56 @@
>>  import error
>>
>>  class peerrepository(object):
>> +    '''peer API:
>> +
>> +    local functions:
>> +        local
>> +            returns local repository object or None
>> +        peer
>> +            returns self
>> +        canpush
>> +            True if peer is writable, False otherwise
>[etc...]
>
>Why aren't these just docstrings on the methods in question? Looking
>at this class docstring, I can't tell what args each method takes, so
>I still have to go find the 'def' line for it. Might as well put the
>docs there.

Good point; we would have to add the empty methods for that, but I guess
that's not a problem really.

-Sune