📝 Add usage link to RootModel (#7113)

pydantic · Aug 14, 2023 · fb74946 · fb74946
1 parent d70abd8
commit fb74946
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/docs/usage/models.md b/docs/usage/models.md
@@ -910,6 +910,9 @@ except ValidationError as e:
 
 ## `RootModel` and custom root types
 
+??? api "API Documentation"
+    [`pydantic.root_model.RootModel`][pydantic.root_model.RootModel]<br>
+
 Pydantic models can be defined with a "custom root type" by subclassing [`pydantic.RootModel`][pydantic.RootModel].
 
 The root type can be any type supported by Pydantic, and is specified by the generic parameter to `RootModel`.

diff --git a/pydantic/root_model.py b/pydantic/root_model.py
@@ -25,7 +25,9 @@
 
 
 class RootModel(BaseModel, typing.Generic[RootModelRootType]):
-    """A Pydantic `BaseModel` for the root object of the model.
+    """usage docs: https://docs.pydantic.dev/2.1/usage/models/#rootmodel-and-custom-root-types
+
+    A Pydantic `BaseModel` for the root object of the model.
 
     Attributes:
         root: The root object of the model.