]> git.ipfire.org Git - thirdparty/fastapi/fastapi.git/commitdiff
📝 Fix doctrings for `max_digits` and `decimal_places` (#14944)
authorMotov Yurii <109919500+YuriiMotov@users.noreply.github.com>
Wed, 4 Mar 2026 12:52:48 +0000 (13:52 +0100)
committerGitHub <noreply@github.com>
Wed, 4 Mar 2026 12:52:48 +0000 (13:52 +0100)
Fix doctrings for `max_digits` and `decimal_places`

fastapi/param_functions.py

index 4be504f43570131375c55b5e11620cca3b80ccb6..d3edde2682f745ee7026d1e13041305fd97d49c9 100644 (file)
@@ -211,7 +211,7 @@ def Path(  # noqa: N802
         int | None,
         Doc(
             """
-            Maximum number of allow digits for strings.
+            Maximum number of digits allowed for decimal values.
             """
         ),
     ] = _Unset,
@@ -219,7 +219,7 @@ def Path(  # noqa: N802
         int | None,
         Doc(
             """
-            Maximum number of decimal places allowed for numbers.
+            Maximum number of decimal places allowed for decimal values.
             """
         ),
     ] = _Unset,
@@ -570,7 +570,7 @@ def Query(  # noqa: N802
         int | None,
         Doc(
             """
-            Maximum number of allow digits for strings.
+            Maximum number of digits allowed for decimal values.
             """
         ),
     ] = _Unset,
@@ -578,7 +578,7 @@ def Query(  # noqa: N802
         int | None,
         Doc(
             """
-            Maximum number of decimal places allowed for numbers.
+            Maximum number of decimal places allowed for decimal values.
             """
         ),
     ] = _Unset,
@@ -892,7 +892,7 @@ def Header(  # noqa: N802
         int | None,
         Doc(
             """
-            Maximum number of allow digits for strings.
+            Maximum number of digits allowed for decimal values.
             """
         ),
     ] = _Unset,
@@ -900,7 +900,7 @@ def Header(  # noqa: N802
         int | None,
         Doc(
             """
-            Maximum number of decimal places allowed for numbers.
+            Maximum number of decimal places allowed for decimal values.
             """
         ),
     ] = _Unset,
@@ -1198,7 +1198,7 @@ def Cookie(  # noqa: N802
         int | None,
         Doc(
             """
-            Maximum number of allow digits for strings.
+            Maximum number of digits allowed for decimal values.
             """
         ),
     ] = _Unset,
@@ -1206,7 +1206,7 @@ def Cookie(  # noqa: N802
         int | None,
         Doc(
             """
-            Maximum number of decimal places allowed for numbers.
+            Maximum number of decimal places allowed for decimal values.
             """
         ),
     ] = _Unset,
@@ -1526,7 +1526,7 @@ def Body(  # noqa: N802
         int | None,
         Doc(
             """
-            Maximum number of allow digits for strings.
+            Maximum number of digits allowed for decimal values.
             """
         ),
     ] = _Unset,
@@ -1534,7 +1534,7 @@ def Body(  # noqa: N802
         int | None,
         Doc(
             """
-            Maximum number of decimal places allowed for numbers.
+            Maximum number of decimal places allowed for decimal values.
             """
         ),
     ] = _Unset,
@@ -1842,7 +1842,7 @@ def Form(  # noqa: N802
         int | None,
         Doc(
             """
-            Maximum number of allow digits for strings.
+            Maximum number of digits allowed for decimal values.
             """
         ),
     ] = _Unset,
@@ -1850,7 +1850,7 @@ def Form(  # noqa: N802
         int | None,
         Doc(
             """
-            Maximum number of decimal places allowed for numbers.
+            Maximum number of decimal places allowed for decimal values.
             """
         ),
     ] = _Unset,
@@ -2157,7 +2157,7 @@ def File(  # noqa: N802
         int | None,
         Doc(
             """
-            Maximum number of allow digits for strings.
+            Maximum number of digits allowed for decimal values.
             """
         ),
     ] = _Unset,
@@ -2165,7 +2165,7 @@ def File(  # noqa: N802
         int | None,
         Doc(
             """
-            Maximum number of decimal places allowed for numbers.
+            Maximum number of decimal places allowed for decimal values.
             """
         ),
     ] = _Unset,