]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
Document Enum.enums is now a list
authorMike Bayer <mike_mp@zzzcomputing.com>
Thu, 20 Oct 2016 20:29:30 +0000 (16:29 -0400)
committerMike Bayer <mike_mp@zzzcomputing.com>
Thu, 20 Oct 2016 20:29:30 +0000 (16:29 -0400)
Change-Id: I27251c262f919df1b084cbb08759f672f05cd3f7
Fixes: #3834
doc/build/changelog/migration_11.rst

index ce17fd3f640174776e25ac0ab108ac4379ef6459..04bdd72e99571e57cdd93a1ea5b71aa6f5ea78cb 100644 (file)
@@ -1528,6 +1528,13 @@ string values::
     e.execute(t.insert(), {"value": MyEnum.two})
     assert e.scalar(t.select()) is MyEnum.two
 
+The ``Enum.enums`` collection is now a list instead of a tuple
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+As part of the changes to :class:`.Enum`, the :attr:`.Enum.enums` collection
+of elements is now a list instead of a tuple.  This because lists
+are appropriate for variable length sequences of homogeneous items where
+the position of the element is not semantically significant.
 
 :ticket:`3292`