Skip to content

Commit

Permalink
docs: expose API under ibis when possible
Browse files Browse the repository at this point in the history
When looking at the reference, some methods are listed by where they
are implemented, not where they are exposed publicly. eg
`ibis.connect()` signature is listed as
`backends.base.connect(resource, **kwargs)`
currently. This commit changes that to simple
`connect(resource, **kwargs)`
where possible.

For some reason I couldn't do this
for `ibis.NA`, not sure why...
  • Loading branch information
NickCrews authored and cpcloud committed Oct 1, 2023
1 parent e4a8630 commit bc05ced
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -245,26 +245,26 @@ quartodoc:
- name: Scalar
package: ibis.expr.types.generic
- name: literal
package: ibis.expr.api
dynamic: true
- name: param
dynamic: true
- name: NA
# Ideally exposed under `ibis` but that doesn't seem to work??
package: ibis.expr.api
- name: "null"
dynamic: true
- name: coalesce
package: ibis.expr.api
dynamic: true
- name: least
package: ibis.expr.api
dynamic: true
- name: greatest
package: ibis.expr.api
dynamic: true
- name: asc
dynamic: true
- name: desc
dynamic: true
- name: ifelse
package: ibis.expr.api
dynamic: true
- name: case
dynamic: true
- name: show_sql
Expand Down Expand Up @@ -458,7 +458,7 @@ quartodoc:
desc: Create and manage backend connections.
contents:
- name: connect
package: ibis.backends.base
dynamic: true
- name: get_backend
dynamic: true
- name: set_backend
Expand Down

0 comments on commit bc05ced

Please sign in to comment.