^{Originally posted byjamesbrazaOctober 26, 2023}

First Check

• I added a very descriptive title here.
• I used the GitHub search to find a similar question and didn't find it.
• I searched the FastAPI documentation, with the integrated search.
• I already searched in Google "How to X in FastAPI" and didn't find any information.
• I already read and followed all the tutorial in the docs and didn't find an answer.
• I already checked if it is not related to FastAPI but toPydantic.
• I already checked if it is not related to FastAPI but toSwagger UI.
• I already checked if it is not related to FastAPI but toReDoc.

Commit to Help

• I commit to help with one of those options 👆

Example Code

fromfastapiimportFastAPI

app=FastAPI()


@app.post("/lof")
deffoo(arg:int=5)->int:
"""
Some function.

\f

Args:
arg: Some argument

Returns:
Some integer.
"""
returnarg

Description

Runningruff==0.1.3on this,D301will autofix to make the docstring be a raw string (lead byr).

@app.post("/lof")
deffoo(arg:int=5)->int:
r "" "
Some function.

\f

Args:
arg: Some argument

Returns:
Some integer.
"""
returnarg

However, this breaks the form feed\ftruncation from working, perhttps://fastapi.tiangolo /advanced/path-operation-advanced-configuration/#advanced-description-from-docstring

I think form feed\ftruncation should still work even if the docstring is a raw string.

Operating System

macOS

Operating System Details

n/a

FastAPI Version

0.104.0

Pydantic Version

2.4.2

Python Version

3.11.5

Additional Context

No response