docformatter

docformatter

Kode
Dokumen
GitHub
PyPi

Memformat dokumen untuk mengikuti PEP 257.

Fitur

docformatter secara otomatis memformat docstring untuk mengikuti subset konvensi PEP 257. Di bawah ini adalah item relevan yang dikutip dari PEP 257.

• Untuk konsistensi, selalu gunakan tanda kutip ganda tiga kali lipat di sekitar dokumen.
• Tanda kutip rangkap tiga digunakan meskipun stringnya muat dalam satu baris.
• Dokumen multi-baris terdiri dari baris ringkasan seperti dokumen satu baris, diikuti dengan baris kosong, diikuti dengan deskripsi yang lebih rumit.
• Kecuali jika seluruh dokumen cocok dalam satu baris, tempatkan tanda kutip penutup pada satu baris saja.

docformatter juga menangani beberapa konvensi PEP 8.

• Jangan menulis string literal yang mengandalkan spasi tambahan yang signifikan. Spasi tambahan tersebut secara visual tidak dapat dibedakan dan beberapa editor (atau yang terbaru, reindent.py) akan memangkasnya.

docformatter memformat docstrings yang kompatibel dengan black ketika melewati opsi --black .

daftar bidang format docformatter yang menggunakan gaya Epytext atau Sphinx.

Lihat dokumentasi selengkapnya di read-the-docs, terutama bagian persyaratan untuk pembahasan lebih rinci tentang PEP 257 dan persyaratan lainnya.

Instalasi

Dari pip:

 $ pip install --upgrade docformatter

Atau, jika Anda ingin menggunakan pyproject.toml untuk mengonfigurasi docformatter dan Anda menggunakan Python <3.11:

 $ pip install --upgrade docformatter[tomli]

Dengan Python >=3.11, tomllib dari perpustakaan standar digunakan.

Atau, jika Anda ingin menggunakan kandidat rilis (atau tag lainnya):

 $ pip instal git+https://github.com/PyCQA/docformatter.git@

Dimana adalah tag kandidat rilis yang ingin Anda pasang. Tag kandidat rilis akan memiliki format v1.6.0-rc1 Kandidat rilis juga akan tersedia sebagai Rilis Github.

Contoh

Setelah berjalan:

 $ docformatter --di tempat example.py

kode ini

 """   Here are some examples.

    This module docstring should be dedented."""


def launch_rocket ():
    """Launch
the
rocket. Go colonize space."""


def factorial ( x ):
    '''

    Return x factorial.

    This uses math.factorial.

    '''
    import math
    return math . factorial ( x )


def print_factorial ( x ):
    """Print x factorial"""
    print ( factorial ( x ))


def main ():
    """Main
    function"""
    print_factorial ( 5 )
    if factorial ( 10 ):
        launch_rocket ()

akan diformat menjadi ini

 """Here are some examples.

This module docstring should be dedented.
"""


def launch_rocket ():
    """Launch the rocket.

    Go colonize space.
    """


def factorial ( x ):
    """Return x factorial.

    This uses math.factorial.
    """
    import math
    return math . factorial ( x )


def print_factorial ( x ):
    """Print x factorial."""
    print ( factorial ( x ))


def main ():
    """Main function."""
    print_factorial ( 5 )
    if factorial ( 10 ):
        launch_rocket ()

Pemasaran

Apakah Anda menggunakan format dokumen ? Dokumen gaya apa yang Anda gunakan? Tambahkan beberapa lencana ke README proyek Anda dan beri tahu semua orang.

 .. gambar:: https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg
    :target: https://github.com/PyCQA/docformatter

.. gambar:: https://img.shields.io/badge/%20style-sphinx-0a507a.svg
    :target: https://www.sphinx-doc.org/en/master/usage/index.html

.. gambar:: https://img.shields.io/badge/%20style-numpy-459db9.svg
    :target: https://numpydoc.readthedocs.io/en/latest/format.html

.. gambar:: https://img.shields.io/badge/%20style-google-3666d6.svg
    :target: https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings

Masalah

Bug dan patch dapat dilaporkan di halaman GitHub.