Enhance AddConstraint/DropConstraint documentation #12355
Conversation
The fact that instantiating an AddConstrant or DropConstraint instance prevents a constraint that has been included in a table definition from being emitted in a CREATE TABLE statement was undocumented. Remedy by expanding the docstrings for those classes.
CaselIT
left a comment
There was a problem hiding this comment.
maybe a bit verbose but it's fine for me
this is news to me. Please report a bug? thanks |
|
this seems to be some ancient rule buried in schema which we should consider removing, or turning into some explicit flag https://gerrit.sqlalchemy.org/c/sqlalchemy/sqlalchemy/+/5730 will see how far this change goes |
|
It seems that the current form of the behavior comes from f9cb6f5 (see the comment at f9cb6f5#diff-e9a75a522975378e61405c5f9bf62e6241b8fe24f21eefd83bf4987a56f82e70R1279 for the rationale). Prior to that, the |
|
so what I want to do here is add a parameter to the add/drop constraint that defaults to True which controls the behavior. that way the parameter will document that this thing is happening, and it can be turned off. i can open an issue for that |
Description
The fact that instantiating an
AddConstrantorDropConstraintinstance prevents a constraint that has been included in a table definition from being emitted in a CREATE TABLE statement was undocumented. Remedy by expanding the docstrings for those classes.Checklist
This pull request is:
must include a complete example of the issue. one line code fixes without an
issue and demonstration will not be accepted.
Fixes: #<issue number>in the commit messageinclude a complete example of how the feature would look.
Fixes: #<issue number>in the commit message