docstring

7ısı

2cevap

Bir Python nesnesinin tüm üyeleri için kısa bir belgeyi yazdırmanın bir yolu var mı?

Python'da dir() geçerli yerel kapsamdaki adların listesini döndürür. __doc__, bir nesnenin tüm belgelerini döndürür. Geçerli yerel kapsamdaki tüm adları nasıl listeleyebilir ve her öğenin belgesinin i

21ısı

2cevap

print (__ doc__) Python 3 komut dosyasında

print(__doc__)in this Scikit example gibi bir komut dosyasının başlangıcında ne yaptıklarını anlayamıyorum. Ben Python Docstringler google seyir olmuştur ve __doc__ fonksiyonları, diyelim ki, bazı bel

7ısı

1cevap

Sfenks'imi GPL bildirimi göz ardı etmek için nasıl kullanırım?

Python paketimi belgelemek için Sphinx kullanıyorum. Benim modülünde automodule yönergesini kullandığınızda: .. automodule:: mymodule :members: O docstringe içinde GPL ibaresinin bulunması her şeyi

6ısı

1cevap

dict için python docstring ekleme

Sözlük parametresi için bir docstring eklemenin önerilen yolu nedir? Birden çok satırdaki doc-string örneğini here görebilirim. Giriş argümanlarını dokümanın içindeki bir işleve belgelemem gerekiyor.

16ısı

1cevap

Python Docstring: yükseltmek vs yükseltmek

PEP0257 uyumlu docstrings işçiliği yardımcı olan PyCharm IDE'yi kullanıyorum. Ben tamamen arasındaki ayrım/kullanabilecekleri anlamıyorum iki nitelik sağlar: :raise Exception: exception explanation he

6ısı

1cevap

PyCharm'ın docstring şablonunun kullanımı nedir? Bunu nasıl verimli kullanırım?

PyCharm, Python IDE, docstring'i yazmaya başladığımda docstring için bir şablon oluşturur. Bu basit bir işlev için oluşturulan şablon. def add_them(x, y): """ :param x: :param y:

11ısı

3cevap

Django RestFramework'da, Api Kök belgeleri nasıl değiştirilir?

django RestFramework'da "Api Root" için belgelerin üretilmesi için herhangi bir "resmi" yol var mı? from rest_framework import routers class MyRouter(routers.DefaultRouter): def get_api_root_vi

7ısı

1cevap

Python Docstrings öğesinden GitHub Wiki Belgelerini Otomatik Olarak Oluştur

Başlık, her şeyi açıklıyor. Hayal ettiğim şey, tüm modüllerim, sınıflarım ve işlevlerim için belge dizileri kullanmaktır ve bir şekilde github (wiki?) Aracılığıyla dokümana güzelce gitmektedir. Ayrıca

55ısı

3cevap

Özel PyCharm docstring taslakları (ör. Google docstring veya numpydoc biçimleri için)

PyCharm 2.7 (veya PyCharm 3) özel dokümanlar ve doktrinler için destek sağlıyor mu? Öyleyse, bu özel uzantı türünü yazmaktan nasıl bahseder? Şu anki projem, Google Python Style Guide (http://google-st

9ısı

3cevap

Birden çok dil için python'da belge oluşturma

Kendim için yeni bir modül oluşturmak istiyorum ancak bazı iş arkadaşlarının da bunu kullanmasını istiyorum. Belgelerimi İngilizce yazmaya başladım ama sonra bu dili iyi anlamayan bir kısmı için modül