Skip to content

DOC: read_sql_query docstring contraine wrong examples #58094

Closed
@Tonow

Description

@Tonow

The issuse is a line :

... data = pd.read_sql_table("data", conn) # doctest: +SKIP

The example is for the wrong function s/read_sql_table/read_sql_query

    Examples
    --------
    >>> from sqlalchemy import create_engine  # doctest: +SKIP
    >>> engine = create_engine("sqlite:///database.db")  # doctest: +SKIP
    >>> with engine.connect() as conn, conn.begin():  # doctest: +SKIP
    ...     data = pd.read_sql_table("data", conn)  # doctest: +SKIP

Should be replace by somthing like

    Examples
    --------
    >>> from sqlalchemy import create_engine  # doctest: +SKIP
    >>> engine = create_engine("sqlite:///database.db")  # doctest: +SKIP
    >>> sql_query = 'SELECT int_column FROM test_data  # doctest: +SKIP
    >>> with engine.connect() as conn, conn.begin():  # doctest: +SKIP
    ...     data = pd.read_sql_query(sql_query, conn)  # doctest: +SKIP

And this will modify https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.read_sql_query.html

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions