Skip to content

DOC: Reference to type 'pd_table' in IO Tools User Guide #26868

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

Closed
oguzhanogreden opened this issue Jun 15, 2019 · 2 comments · Fixed by #26872
Closed

DOC: Reference to type 'pd_table' in IO Tools User Guide #26868

oguzhanogreden opened this issue Jun 15, 2019 · 2 comments · Fixed by #26872
Labels
Docs IO SQL to_sql, read_sql, read_sql_query
Milestone

Comments

@oguzhanogreden
Copy link
Contributor

Insertion Method section of the reference refers to "pd_table" in the function signature. This is the only place it is used in the whole documentation. Search engines results for "pd_table" are mostly examples where it's used to refer to pd.DataFrame, so it's rather confusing.

Not sure what's the best way to make this clear but the signature should refer to pandas.io.SQLTable().

This was added in #21401. I came across this while working on #26795.

@WillAyd
Copy link
Member

WillAyd commented Jun 15, 2019

Great research into this! I think this is where annotations will make things more clear though; if you add annotation for pd_table to be a SQLTable I think that should help a lot - did you have something else in mind?

@oguzhanogreden
Copy link
Contributor Author

oguzhanogreden commented Jun 15, 2019

Thanks!

That seems to cause a circular import problem. See latest tests of #26795 and my comment here. I may be missing an obvious solution there...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs IO SQL to_sql, read_sql, read_sql_query
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants