marshmallow-sqlalchemy icon indicating copy to clipboard operation
marshmallow-sqlalchemy copied to clipboard

Is there documentation for SQLAlchemySchema's or SQLAlchemyAutoSchema's `load` method?

Open alichaudry opened this issue 1 year ago • 1 comments

I've looked at the documentation here and under sqla_session it says You can also pass a session to the Schema’s load method. However, it's unclear how to pass the session to the load method. Is it sqla_session as well, or something else? I've searched the documentation for the signature of this method but I was unable to find any details.

I was able to make it work by looking at the function signature in the source code here.

Is this just a case of missing documentation, or am I using an undocumented feature by having to look in the source code?

alichaudry avatar Oct 10 '24 17:10 alichaudry

Good catch! It's documented here, but I don't think this appears in the sphinx docs. It is public API, so we should definitely document this more clearly

sloria avatar Oct 12 '24 02:10 sloria