docformatter
v1.7.5
| شفرة | |
| مستندات | |
| جيثب | |
| بيبي | |
تنسيقات سلاسل المستندات لمتابعة PEP 257.
يقوم docformatter تلقائيًا بتنسيق سلاسل المستندات لتتبع مجموعة فرعية من اتفاقيات PEP 257. فيما يلي العناصر ذات الصلة المقتبسة من PEP 257.
يتعامل docformatter أيضًا مع بعض اتفاقيات PEP 8.
يقوم docformatter بتنسيق سلاسل المستندات المتوافقة مع black عند تمرير الخيار --black .
قوائم حقول تنسيقات docformatter التي تستخدم أنماط Epytext أو Sphinx.
راجع الوثائق الكاملة في read-the-docs، وخاصة قسم المتطلبات للحصول على مناقشة أكثر تفصيلاً لـ PEP 257 والمتطلبات الأخرى.
من النقطة:
$ تثبيت النقطة - ترقية docformatter
أو، إذا كنت تريد استخدام pyproject.toml لتكوين docformatter وكنت تستخدم Python <3.11:
تثبيت النقطة $ - ترقية docformatter[tomli]
مع Python >=3.11، يتم استخدام tomllib من المكتبة القياسية.
أو، إذا كنت تريد استخدام مرشح الإصدار (أو أي علامة أخرى):
تثبيت النقطة $ 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 ؟ ما هو نمط المستندات الذي تستخدمه؟ أضف بعض الشارات إلى الملف التمهيدي الخاص بمشروعك وأخبر الجميع بذلك.
.. الصورة:: https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg
:الهدف: https://github.com/PyCQA/docformatter
.. الصورة:: https://img.shields.io/badge/%20style-sphinx-0a507a.svg
:الهدف: https://www.sphinx-doc.org/en/master/usage/index.html
.. الصورة:: https://img.shields.io/badge/%20style-numpy-459db9.svg
:الهدف: https://numpydoc.readthedocs.io/en/latest/format.html
.. الصورة:: https://img.shields.io/badge/%20style-google-3666d6.svg
:الهدف: https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings
يمكن الإبلاغ عن الأخطاء والتصحيحات على صفحة GitHub.
