Tamam, çok okudum hem PEP 8 PEP 257, ve yazdım çok docstrings fonksiyonları ve sınıfları, ama ben emin hakkında ne gitmesi gerektiğini modülü kütüphane. Modülü ihracat işlevleri ve sınıfları belge gerekir, en azından ben düşündüm, ama aynı zamanda yazar adları, telif hakkı bilgileri, vb listesi birkaç modülleri gördüm. Herkes iyi bir python kütüphane yapılandırılmış nasıl olması gerektiğine dair bir örnek var mı?

Düşün biri etkileşimli çevirmenin istemi -- help(yourmodule) her zaman yaptıklarını yapıyoristiyorumbilmek? (Ve bilgi alma gösteren diğer yöntemler bilgi miktarı açısından help) kabaca eşdeğerdir. Eğer öyleyse x.py varsa:

"""This module does blah blah."""

class Blah(object):
  """This class does blah blah."""

sonra:

>>> import x; help(x)

gösterir:

Help on module x:

NAME
    x - This module does blah blah.

FILE
    /tmp/x.py

CLASSES
    __builtin__.object
        Blah

    class Blah(__builtin__.object)
     |  This class does blah blah.
     |  
     |  Data and other attributes defined here:
     |  
     |  __dict__ = <dictproxy object>
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__ = <attribute '__weakref__' of 'Blah' objects>
     |      list of weak references to the object (if defined)

Gördüğünüz gibi, ayrıntılı bilgi sınıfları (ve fonksiyonları da değilim gösteren bir buraya) zaten dahil bu bileşenleri' docstrings; modülün kendi kütüphane gerektiğini açıklayın bunları çok özetle ( ... ) ve oldukça konsantre bir kısa özeti ne modülü olarak bir bütün olabilir yapmak için ideal olan bazı doctested örnekleri (gibi işlevleri ve sınıfları ideal olmalı doctested örneklerde theit docstrings).

Anlayamıyorum, nasıl meta gibi yazarın adı ve telif hakkı / lisans yardımcı modülünün kullanıcı -- bunun yerine git yorum, beri yardımcı olacak birileri dikkate olsun veya olmasın yeniden veya değiştirme modülü.