Skip to content

Commit

Permalink
docs(api): show source for classes to allow dunder method inspection
Browse files Browse the repository at this point in the history
Apply suggestions from code review

Co-authored-by: Phillip Cloud <417981+cpcloud@users.noreply.github.com>
  • Loading branch information
gforsyth and cpcloud committed Jun 10, 2023
1 parent 6724b7b commit 4cef0f8
Show file tree
Hide file tree
Showing 8 changed files with 64 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/api/expressions/collections.md
Expand Up @@ -2,6 +2,14 @@

These APIs are available on arrays, maps and structs.

<!-- prettier-ignore-start -->
::: ibis.expr.types.arrays.ArrayValue
options:
show_source: true
::: ibis.expr.types.structs.StructValue
options:
show_source: true
::: ibis.expr.types.maps.MapValue
options:
show_source: true
<!-- prettier-ignore-end -->
8 changes: 8 additions & 0 deletions docs/api/expressions/generic.md
Expand Up @@ -2,6 +2,14 @@

These expressions are available on scalars and columns of any element type.

<!-- prettier-ignore-start -->
::: ibis.expr.types.generic.Value
options:
show_source: true
::: ibis.expr.types.generic.Column
options:
show_source: true
::: ibis.expr.types.generic.Scalar
options:
show_source: true
<!-- prettier-ignore-end -->
6 changes: 6 additions & 0 deletions docs/api/expressions/geospatial.md
Expand Up @@ -2,5 +2,11 @@

Ibis supports the following geospatial expression APIs

<!-- prettier-ignore-start -->
::: ibis.expr.types.geospatial.GeoSpatialValue
options:
show_source: true
::: ibis.expr.types.geospatial.GeoSpatialColumn
options:
show_source: true
<!-- prettier-ignore-end -->
4 changes: 4 additions & 0 deletions docs/api/expressions/index.md
Expand Up @@ -2,4 +2,8 @@

These APIs are shared by both table and column expressions.

<!-- prettier-ignore-start -->
::: ibis.expr.types.core.Expr
options:
show_source: true
<!-- prettier-ignore-end -->
16 changes: 16 additions & 0 deletions docs/api/expressions/numeric.md
Expand Up @@ -2,14 +2,30 @@

These APIs are available on numeric and boolean expressions.

<!-- prettier-ignore-start -->
::: ibis.expr.types.numeric.NumericValue
options:
show_source: true
::: ibis.expr.types.numeric.NumericColumn
options:
show_source: true

::: ibis.expr.types.numeric.IntegerValue
options:
show_source: true
::: ibis.expr.types.numeric.IntegerColumn
options:
show_source: true

::: ibis.expr.types.numeric.FloatingValue
options:
show_source: true

::: ibis.expr.types.numeric.DecimalValue
options:
show_source: true

::: ibis.expr.types.logical.BooleanValue
options:
show_source: true
<!-- prettier-ignore-end -->
4 changes: 4 additions & 0 deletions docs/api/expressions/strings.md
Expand Up @@ -2,4 +2,8 @@

All string operations are valid for both scalars and columns.

<!-- prettier-ignore-start -->
::: ibis.expr.types.strings.StringValue
options:
show_source: true
<!-- prettier-ignore-end -->
6 changes: 6 additions & 0 deletions docs/api/expressions/tables.md
Expand Up @@ -2,5 +2,11 @@

Table expressions form the basis for most Ibis expressions.

<!-- prettier-ignore-start -->
::: ibis.expr.types.relations.Table
options:
show_source: true
::: ibis.expr.types.groupby.GroupedTable
options:
show_source: true
<!-- prettier-ignore-end -->
12 changes: 12 additions & 0 deletions docs/api/expressions/timestamps.md
Expand Up @@ -2,8 +2,20 @@

All temporal operations are valid for both scalars and columns.

<!-- prettier-ignore-start -->
::: ibis.expr.types.temporal.TemporalValue
options:
show_source: true
::: ibis.expr.types.temporal.TimestampValue
options:
show_source: true
::: ibis.expr.types.temporal.DateValue
options:
show_source: true
::: ibis.expr.types.temporal.TimeValue
options:
show_source: true
::: ibis.expr.types.temporal.IntervalValue
options:
show_source: true
<!-- prettier-ignore-end -->

0 comments on commit 4cef0f8

Please sign in to comment.