Skip to content

DOC:Cleaned up docstrings in sql.py #17967

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

Merged
merged 4 commits into from
Oct 25, 2017

Conversation

scotthavard92
Copy link
Contributor

Tidied up docstrings in pandas/io/sql.py.

pandas/io/sql.py Outdated
@@ -44,7 +44,7 @@ class DatabaseError(IOError):
def _validate_flavor_parameter(flavor):
"""
Checks whether a database 'flavor' was specified.
If not None, produces FutureWarning if 'sqlite' and
If not None, produces FutureWarning if 'SQLite' and
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the previous version with lowercase 'sqlite' is correct, because this is referencing the flavor parameter that's being checked, and it's looking for all lowercase (see line 51).

Copy link
Contributor Author

@scotthavard92 scotthavard92 Oct 24, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are definitely correct. SQLite is the proper capitalization for the library when used as a noun in regular language, but it looks like it needs to be lower case when being implemented. Thanks for spotting that.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be good now I believe.

@jreback jreback added Docs IO SQL to_sql, read_sql, read_sql_query labels Oct 25, 2017
@jreback
Copy link
Contributor

jreback commented Oct 25, 2017

needs a rebase

@jorisvandenbossche jorisvandenbossche merged commit 36c309e into pandas-dev:master Oct 25, 2017
@jorisvandenbossche
Copy link
Member

@scotthavard92 Thanks! (fixed the conflict on merge)

peterpanmj pushed a commit to peterpanmj/pandas that referenced this pull request Oct 31, 2017
No-Stream pushed a commit to No-Stream/pandas that referenced this pull request Nov 28, 2017
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 this pull request may close these issues.

4 participants