Skip to content

Commit d58d251

Browse files
committed
docs fix (claude)
1 parent 640af21 commit d58d251

3 files changed

Lines changed: 15 additions & 1 deletion

File tree

csql/_/models/query.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,11 @@ def preview_pl(
233233
newParams: Mapping[str, ParameterValue] | None = None,
234234
overrides: csql.overrides.Overrides | None = None,
235235
) -> pl.DataFrame:
236+
"""
237+
Return a small polars DataFrame to preview the results of this query.
238+
239+
:rtype: :class:`polars.DataFrame`
240+
"""
236241
import polars as pl
237242

238243
from ..utils import limit_query

csql/__init__.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,25 @@
99
ParameterList as _Deprecated_ParameterList,
1010
)
1111
from ._.models.query import (
12+
ClickhouseQueryArgs,
13+
DuckDBQueryArgs,
1214
ParameterPlaceholder,
1315
Parameters,
1416
ParameterValue,
17+
PolarsQueryArgs,
1518
Query,
1619
QueryBit,
1720
RenderedQuery,
1821
)
1922
from .overrides import Overrides as _Deprecated_Overrides
2023

2124
__all__ = [
25+
"ClickhouseQueryArgs",
26+
"DuckDBQueryArgs",
2227
"ParameterPlaceholder",
2328
"ParameterValue",
2429
"Parameters",
25-
"Parameters",
30+
"PolarsQueryArgs",
2631
"Q",
2732
"Query",
2833
"QueryBit",

docs/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,12 @@ def check_output(self, want, got, optionflags):
131131
intersphinx_mapping = {
132132
"python": ("https://docs.python.org/3", None),
133133
"pandas": ("https://pandas.pydata.org/docs/", None),
134+
"polars": ("https://docs.pola.rs/api/python/stable/", None),
134135
}
135136

137+
# polars's published inventory doesn't index the DataFrame class itself, only its methods.
138+
nitpick_ignore = [("py:class", "polars.DataFrame")]
139+
136140
autosummary_generate = False
137141
autosummary_imported_members = True
138142
autosummary_ignore_module_all = False

0 commit comments

Comments
 (0)