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: correct link generated in operations matrix #10345

Merged
merged 1 commit into from
Oct 21, 2024

Conversation

Jlobblet
Copy link
Contributor

Description of changes

The operation support matrix has links to each operation, but they don’t work. This fixes that by updating the link to the current address of those operations.

Issues closed

@github-actions github-actions bot added the docs Documentation related issues or PRs label Oct 21, 2024
@cpcloud cpcloud added the docs-preview Add this label to trigger a docs preview label Oct 21, 2024
@ibis-docs-bot ibis-docs-bot bot removed the docs-preview Add this label to trigger a docs preview label Oct 21, 2024
@cpcloud
Copy link
Member

cpcloud commented Oct 21, 2024

@Jlobblet Thanks!

I've kicked off a docs-preview job for this PR, so in about 10-15 minutes we can check that your fix works!

@Jlobblet
Copy link
Contributor Author

Looks like there are still some oddities around things present in the matrix but not the reference (e.g., DenseRank) but that is beyond the scope of this PR

@Jlobblet
Copy link
Contributor Author

Other things I have spotted so far that don't match up:

  • core category
  • some relations
  • rewrites category
  • udf category
  • vectorized category

@cpcloud
Copy link
Member

cpcloud commented Oct 21, 2024

Yep, I think we are simply missing all those in the API docs. I'm not sure if we can generate them automatically and keep the same layout.

At the moment we're simply listing all the operations we want to show up in the docs in _quarto.yml, but ideally quarto docs would discover this for us and generate the output.

@cpcloud cpcloud added this to the 10.0 milestone Oct 21, 2024
@cpcloud
Copy link
Member

cpcloud commented Oct 21, 2024

In any event, I'm going to merge this PR. Thanks again!

@cpcloud cpcloud merged commit c7c929d into ibis-project:main Oct 21, 2024
22 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.

docs: operation support matrix does not have working links
2 participants