docformatter
v1.7.5
| รหัส | |
| เอกสาร | |
| GitHub | |
| ปิ๊ปิ | |
จัดรูปแบบเอกสารให้เป็นไปตาม PEP 257
docformatter จัดรูปแบบสตริงเอกสารให้เป็นไปตามชุดย่อยของแบบแผน PEP 257 โดยอัตโนมัติ ด้านล่างนี้เป็นรายการที่เกี่ยวข้องที่ยกมาจาก PEP 257
docformatter ยังจัดการรูปแบบ PEP 8 บางส่วนด้วย
docformatter จัดรูปแบบ docstrings ที่เข้ากันได้กับ black เมื่อผ่านตัวเลือก --black
รายการฟิลด์รูป docformatter ที่ใช้สไตล์ Epytext หรือ Sphinx
ดูเอกสารฉบับเต็มได้ที่ read-the-docs โดยเฉพาะส่วนข้อกำหนดสำหรับการอภิปรายโดยละเอียดเพิ่มเติมเกี่ยวกับ PEP 257 และข้อกำหนดอื่นๆ
จากปิ๊ป:
$ pip ติดตั้ง -- อัปเกรด docformatter
หรือหากคุณต้องการใช้ pyproject.toml เพื่อกำหนดค่า docformatter และคุณใช้ Python < 3.11:
$ pip ติดตั้ง -- อัปเกรด docformatter [tomli]
ด้วย Python >=3.11 จะใช้ tomllib จากไลบรารีมาตรฐาน
หรือหากคุณต้องการใช้ตัวเลือกการเผยแพร่ (หรือแท็กอื่น ๆ ):
$ pip ติดตั้ง git+https://github.com/PyCQA/docformatter.git@
โดยที่
หลังจากทำงาน:
$ docformatter --in-place example.py
รหัสนี้
""" 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 ()ได้รับการฟอร์แมตเป็นสิ่งนี้
"""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 ()คุณใช้ docformatter หรือ ไม่? คุณใช้เอกสารรูปแบบใด เพิ่มป้ายสถานะให้กับ README ของโครงการของคุณและแจ้งให้ทุกคนทราบ
.. รูปภาพ:: https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg
:target: https://github.com/PyCQA/docformatter
.. ภาพ:: https://img.shields.io/badge/%20style-sphinx-0a507a.svg
:target: https://www.sphinx-doc.org/en/master/usage/index.html
.. รูปภาพ:: https://img.shields.io/badge/%20style-numpy-459db9.svg
:target: https://numpydoc.readthedocs.io/en/latest/format.html
.. รูปภาพ:: https://img.shields.io/badge/%20style-google-3666d6.svg
:target: https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings
สามารถรายงานข้อบกพร่องและแพทช์ได้ในหน้า GitHub
