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.

Sign up for GitHub

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

Jump to bottom

docs: add API docs for operations #9233

Merged
merged 21 commits into from
May 28, 2024
Merged

docs: add API docs for operations #9233

merged 21 commits into from
May 28, 2024

Conversation

cpcloud
Copy link
Member

@cpcloud cpcloud commented May 22, 2024 •
edited

Document operations and add links in support matrix.

DISCLAIMER: Many of the docstrings here were generated with GitHub Copilot. Each one was reviewed individually by me for correctness.

@cpcloud cpcloud added this to the 9.1 milestone May 22, 2024
@cpcloud cpcloud added the docs Documentation related issues or PRs label May 22, 2024
@gforsyth gforsyth linked an issue May 22, 2024 that may be closed by this pull request
docs: add ops docstrings #9231
Closed
1 task
@gforsyth gforsyth added the docs-preview Add this label to trigger a docs preview label May 22, 2024
@ibis-docs-bot ibis-docs-bot bot removed the docs-preview Add this label to trigger a docs preview label May 22, 2024
@ibis-docs-bot
Copy link

ibis-docs-bot bot commented May 22, 2024

Docs preview: https://pr-9233-755856d56ce22f9a18b78423a2631fdb12f4620c--ibis-quarto.netlify.app

gforsyth
gforsyth reviewed May 22, 2024
View reviewed changes
Copy link
Member

@gforsyth gforsyth left a comment

Choose a reason for hiding this comment

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

Sweet! The links from the ops matrix don't work, but I think the suggested change will do the trick

docs/support_matrix.qmd Outdated Show resolved Hide resolved
@cpcloud cpcloud force-pushed the ops-docs branch 2 times, most recently from f20b789 to c703a46 Compare May 27, 2024 13:59
@cpcloud cpcloud added the docs-preview Add this label to trigger a docs preview label May 27, 2024
@ibis-docs-bot ibis-docs-bot bot removed the docs-preview Add this label to trigger a docs preview label May 27, 2024
@ibis-docs-bot
Copy link

ibis-docs-bot bot commented May 27, 2024

Docs preview: https://pr-9233-c703a466054a1e04db201ffd26b0d3299440f7fe--ibis-quarto.netlify.app

@cpcloud cpcloud requested a review from gforsyth May 28, 2024 14:48
@gforsyth gforsyth added the docs-preview Add this label to trigger a docs preview label May 28, 2024
@ibis-docs-bot ibis-docs-bot bot removed the docs-preview Add this label to trigger a docs preview label May 28, 2024
@cpcloud
Copy link
Member Author

cpcloud commented May 28, 2024

As a follow up I would like to see about getting a more meaningful signature displayed than Op(self, **kwargs) for each operation.

@ibis-docs-bot
Copy link

ibis-docs-bot bot commented May 28, 2024

Docs preview: https://pr-9233-6e3b884b58dc473fa7a82059e8e5ada71017f503--ibis-quarto.netlify.app

gforsyth
gforsyth approved these changes May 28, 2024
View reviewed changes
Copy link
Member

@gforsyth gforsyth left a comment

Choose a reason for hiding this comment

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

:shipit:

@gforsyth gforsyth merged commit 11e0530 into ibis-project:main May 28, 2024
87 checks passed
@cpcloud cpcloud deleted the ops-docs branch May 28, 2024 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gforsyth gforsyth gforsyth approved these changes

Assignees
No one assigned
Labels
docs Documentation related issues or PRs
Projects
None yet
Milestone
9.1
Development

Successfully merging this pull request may close these issues.

docs: add ops docstrings
2 participants
@cpcloud @gforsyth