Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(descheming): move callout note outside of parameter description #9133

Merged
merged 1 commit into from
May 7, 2024

Conversation

gforsyth
Copy link
Member

@gforsyth gforsyth commented May 6, 2024

Callouts inside of a parameter description aren't being rendered in the
docs, so I've moved this callout into the main body of the docstring so
it renders correctly.

I've also added the same callout to the read_postgres method on the
DuckDB backend, as postgres users may try to use schema in the
hierarchical sense.

xref #8712

Copy link
Member

@jcrist jcrist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, failure is (I think) unrelated.

Callouts inside of a parameter description aren't being rendered in the
docs, so I've moved this callout into the main body of the docstring so
it renders correctly.

I've also added the same callout to the `read_postgres` method on the
DuckDB backend, as postgres users may try to use `schema` in the
hierarchical sense.
@cpcloud cpcloud added this to the 9.1 milestone May 7, 2024
@cpcloud cpcloud added the docs Documentation related issues or PRs label May 7, 2024
@cpcloud cpcloud enabled auto-merge (squash) May 7, 2024 15:43
@cpcloud cpcloud merged commit bb7bdb3 into ibis-project:main May 7, 2024
84 checks passed
@gforsyth gforsyth deleted the fix_schema_callouts branch May 7, 2024 21:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related issues or PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants