Tweak documentation of Field.exclude

[Viicos]

Change Summary

I don't know if this is expected, but doing the following:

from typing import Annotated, TypeVar

from pydantic import BaseModel, Field

T = TypeVar("T")

ExcludedField = Annotated[T, Field(exclude=True)]


class Model(BaseModel):
    run_path: ExcludedField[str | None] = None

Model.model_json_schema()
#> {'properties': {'run_path': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'default': None, 'title': 'Run Path'}}, 'title': 'Model', 'type': 'object'}
Model(run_path="a").model_dump()
#> {}

The field is still included in the JSON Schema. So either the docstring is incorrect or it should not be included in the JSON Schema as well?

Related issue number

Checklist

• The pull request title is a good summary of the changes - it will be used in the changelog
• Unit tests for the changes exist
• Tests pass on CI
• Documentation reflects the changes where applicable
• My PR is ready to review, please add a comment including the phrase "please review" to assign reviewers

Selected Reviewer: @adriangb

[Viicos]

Please review

[hramezani]

Thanks @Viicos