From: Sigmund Lahn <s@lahn.no>
Date: Fri, 23 May 2025 11:29:46 +0000 (+0200)
Subject: Add docstrings for parameter `dataclass_metadata`
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9ea6a95b2bc6816e5b69d6d559783a6009877838;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

Add docstrings for parameter `dataclass_metadata`
---

diff --git a/lib/sqlalchemy/orm/_orm_constructors.py b/lib/sqlalchemy/orm/_orm_constructors.py
index b6f3e7d286..d6b5cdf396 100644
--- a/lib/sqlalchemy/orm/_orm_constructors.py
+++ b/lib/sqlalchemy/orm/_orm_constructors.py
@@ -342,6 +342,10 @@ def mapped_column(
 
      .. versionadded:: 2.0.36
 
+    :param dataclass_metadata: Specific to
+     :ref:`orm_declarative_native_dataclasses`, supplies metadata
+     to be attached to the generated dataclass field.
+
     :param \**kw: All remaining keyword arguments are passed through to the
      constructor for the :class:`_schema.Column`.
 
@@ -592,6 +596,9 @@ def column_property(
 
      .. versionadded:: 2.0.36
 
+    :param dataclass_metadata: Specific to
+     :ref:`orm_declarative_native_dataclasses`, supplies metadata
+     to be attached to the generated dataclass field.
     """
     return MappedSQLExpression(
         column,
@@ -787,6 +794,10 @@ def composite(
      class.
 
      .. versionadded:: 2.0.36
+
+    :param dataclass_metadata: Specific to
+     :ref:`orm_declarative_native_dataclasses`, supplies metadata
+     to be attached to the generated dataclass field.
     """
     if __kw:
         raise _no_kw()
@@ -1873,6 +1884,10 @@ def relationship(
      class.
 
      .. versionadded:: 2.0.36
+
+    :param dataclass_metadata: Specific to
+     :ref:`orm_declarative_native_dataclasses`, supplies metadata
+     to be attached to the generated dataclass field.
     """
 
     return _RelationshipDeclared(