Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
alichaudry opened this issue Oct 10, 2024 · 1 comment

Comments

@alichaudry
Copy link

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?

@sloria
Copy link
Member

sloria commented Oct 12, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants