DOC: Clarify dispatch behavior of read_sql #18925
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pandas/io/sql.py
Outdated
| Parameters | ||
| ---------- | ||
| sql : string or SQLAlchemy Selectable (select or text object) | ||
| SQL query to be executed. | ||
| con : SQLAlchemy connectable(engine/connection) or database string URI | ||
| SQL query to be executed or a table name from which to select rows. |
There was a problem hiding this comment.
I would leave out "from which to select rows" (there is no way to do this)
pandas/io/sql.py
Outdated
| ``read_sql_query`` (for backward compatibility). It will delegate | ||
| to the specific function depending on the provided input. | ||
|
|
||
| For example, a SQL query will be routed to ``read_sql_query``, while a |
There was a problem hiding this comment.
I would leave out "For example", as there are no other options.
(I would also keep those two paragraphs as a single paragraph, as it is explaining one topic.
Codecov Report
@@ Coverage Diff @@
## master #18925 +/- ##
==========================================
- Coverage 91.59% 91.57% -0.03%
==========================================
Files 150 150
Lines 48959 48959
==========================================
- Hits 44843 44833 -10
- Misses 4116 4126 +10
Continue to review full report at Codecov.
|
|
@jorisvandenbossche: comments addressed. PTAL. |
|
thanks! |
hexgnu
pushed a commit
to hexgnu/pandas
that referenced
this pull request
Dec 28, 2017
* DOC: Clarify dispatch behavior of read_sql [ci skip] Closes pandas-devgh-18861. * Address reviewer comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Wasn't particularly clear or prominent in the docs.
Closes #18861.