---

Постановка точки в конце docstring-функций или методов имеет несколько преимуществ: ясность и завершённость мысли, единообразие стиля, удобство для инструментов генерации документации.

---

Пример 1¶

Каждая docstring должна заканчиваться точкой. Docstring всегда начинается и оканчивается тройными кавычками.

Плохо:

'''Это пример docstring в тройных одиночных кавычках с забытой точкой'''

Хорошо:

'''Это пример docstring в тройных одиночных кавычках.'''

---

Пример 2¶

Плохо:

from math import pi

def calculate_circle_area(radius):
    '''Вычисляет площадь круга'''
    circle_area = pi * (radius ** 2)
    return circle_area

Хорошо:

from math import pi

def calculate_circle_area(radius):
    '''Вычисляет площадь круга.'''
    circle_area = pi * (radius ** 2)
    return circle_area

---

Пример 3¶

В pydantic, особенно второй версии, при описании полей модели также необходимо заканчивать описания точками.

Плохо:

from pydantic import BaseModel, ConfigDict

class UserSchema(BaseModel):
    username: str
    '''Уникальное имя пользователя'''
    age: int
    '''Возраст пользователя'''

    model_config = ConfigDict(
        use_attribute_docstrings=True,
    )

Хорошо:

from pydantic import BaseModel, ConfigDict

class UserSchema(BaseModel):
    username: str
    '''Уникальное имя пользователя.'''
    age: int
    '''Возраст пользователя.'''

    model_config = ConfigDict(
        use_attribute_docstrings=True,
    )