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: add deferred, range, e, and pi to API reference #9592

Merged
merged 4 commits into from
Jul 15, 2024

Conversation

tswast
Copy link
Collaborator

@tswast tswast commented Jul 15, 2024

Description of changes

Some top-level APIs were missing from the API reference. This adds them.

@cpcloud cpcloud added the docs Documentation related issues or PRs label Jul 15, 2024
@cpcloud cpcloud added this to the 9.2 milestone Jul 15, 2024
@cpcloud cpcloud added the docs-preview Add this label to trigger a docs preview label Jul 15, 2024
@ibis-docs-bot ibis-docs-bot bot removed the docs-preview Add this label to trigger a docs preview label Jul 15, 2024
@tswast
Copy link
Collaborator Author

tswast commented Jul 15, 2024

Re: file:///home/runner/work/ibis/ibis/docs/_output/reference/range | Failed: Cannot find file. I'll try some fixes. Adding a more specific package name seemed to help for the others.

@cpcloud
Copy link
Member

cpcloud commented Jul 15, 2024

That means that there's a file referenced somewhere that doesn't exist. That usually means that wherever you're referencing range, the way you've referenced it is incorrect.

@cpcloud
Copy link
Member

cpcloud commented Jul 15, 2024

Ah, looks like you're not referencing range anywhere, so that may not be the issue.

@gforsyth
Copy link
Member

Looks like the docstring for ibis.range has an invalid link -- let me poke it

@gforsyth
Copy link
Member

I was wrong about interlinks, we do have them, so it may just be how we're spelling it. Poking locally, still

@tswast
Copy link
Collaborator Author

tswast commented Jul 15, 2024

Thanks @gforsyth I see you're updating the PR.

Looks like https://docs.python.org/3/library/functions.html#func-range would be the right link, but yeah if interlinks work it would be good to reference the built-in that way.

@gforsyth gforsyth force-pushed the tswast-missing-docs branch from c423c33 to 5d61b4f Compare July 15, 2024 19:06
@gforsyth
Copy link
Member

ok, that took way too long to figure out, but it's rendering correctly for me now

ibis/expr/api.py Outdated Show resolved Hide resolved
@cpcloud cpcloud enabled auto-merge (squash) July 15, 2024 20:16
@cpcloud cpcloud force-pushed the tswast-missing-docs branch from 619bb6b to aaf081d Compare July 15, 2024 20:53
@cpcloud cpcloud merged commit 43b116b into ibis-project:main Jul 15, 2024
94 checks passed
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