Commit Graph

6 Commits

Author SHA1 Message Date
Mikhail Burshteyn 032376bac1 Fix typo in docs (errors.rst)
(cherry picked from commit af94e639ae)
2019-09-18 08:23:28 -04:00
Mike Bayer 98c483a851 Rework Session transaction FAQs
In preparation for #4712, add an errors.rst code to the Session's
exception about waiting to be rolled back and rework the FAQ entry
to be much more succinct.  When this FAQ was first written, I found
it hard to describe why flush worked this way but as the use case is
clearer now, and #4712 actually showed it being confusing when it doesn't
work this way, we can make a simpler and more definitive statement
about this behavior.   Additionally, language about "subtransactions"
is minimized as I might be removing or de-emphasizing this concept in
2.0 (though maybe not as it does seem to work well).

Change-Id: I557872aff255b07e14dd843aa024e027a017afb8
(cherry picked from commit 4bd3cf69b2)
2019-06-07 14:54:05 -04:00
Mike Bayer 6845be0927 Enhance documentation for string compilation use cases
- Add a web link for UnsupportedCompilationError
- Add new section to errors.rst
- add more detail and cross-linking to the FAQ
- include security caveats for parameter rendering

Fixes: #4595
Change-Id: I31ea57c18d65770cd2a51276bbe2847a9eb72bba
2019-04-04 21:44:49 -04:00
Lele Gaifax 66e88d30a8 Fix many spell glitches
This affects mostly docstrings, except in orm/events.py::dispose_collection()
where one parameter gets renamed: given that the method is
empty, it seemed reasonable to me to fix that too.

Closes: #4440
Pull-request: https://github.com/sqlalchemy/sqlalchemy/pull/4440
Pull-request-sha: 779ed75acb

Change-Id: Ic0553fe97853054b09c2453af76d96363de6eb0e
2019-01-25 14:56:50 -05:00
Mike Bayer 835444be72 Add __clause_element__ to ColumnProperty
Added a ``__clause_element__()`` method to :class:`.ColumnProperty` which
can allow the usage of a not-fully-declared column or deferred attribute in
a declarative mapped class slightly more friendly when it's used in a
constraint or other column-oriented scenario within the class declaration,
though this still can't work in open-ended expressions; prefer to call the
:attr:`.ColumnProperty.expression` attribute if receiving ``TypeError``.

Fixes: #4372
Change-Id: I5d3d1adb9c77de0566298bc2c46e9001d314b0c7
2018-11-27 20:12:16 -05:00
Mike Bayer 1abc8e5500 Add new errors section
Adding this to master so that it can be published, in
advance of the exception-level site integration feature.

Change-Id: Ia2a61df8e5198b81ef8f5fbac91143767b70c26b
2017-12-22 12:35:30 -05:00