launchpad-dev team mailing list archive

[Paul Hummer <paul.hummer@xxxxxxxxxxxxx>]

On 01/25/2011 10:57 AM, Jonathan Lange wrote:
> On Tue, Jan 25, 2011 at 11:06 AM, Paul Hummer <paul.hummer@xxxxxxxxxxxxx> wrote:
> ...
>> I would be -1 on pointing to other documentation.  Wikis generally have
>> this idea where you're continually clicking through to find more
>> information, which tends to lead to people giving up after a few
>> click-throughs.  If it's important outside the realm of general PEP-8
>> type stuff, I think it should be on the page, especially the Zope
>> caveats to PEP-8 (you know, because Zope existed before PEP-8).
>>
> By "-1", do you mean "I disagree" or "I veto"? I ask because in the
> voting system where "+1" comes from[1], -1 means veto.
>
> Either way, you are right that linking sometimes makes a document less
> usable, and we want those docs to be easily usable. Putting a blanket
> ban on linking goes too far.

I would "veto" linking things like the Zope styles, but I would be +1
with linking the PEP 8 or something more detailed (ideally, everyone is
familiar with PEP 8).  A blanket ban on linking doesn't make any sense,
since that basically ruins the internet in general.  :)

I'd be okay with summarizing the big parts of the Zope style that we
care about, and then linking to the their style guide (though I'm not
sure many will actually ever need it).

Cheers,
Paul