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

Update Optimizer documentation #11581

Open
alamb opened this issue Jul 21, 2024 · 1 comment
Open

Update Optimizer documentation #11581

alamb opened this issue Jul 21, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@alamb
Copy link
Contributor

alamb commented Jul 21, 2024

Is your feature request related to a problem or challenge?

@devesh-2002 moved the optimizer documentation in #11563 to the doc site (thank you!)

However, the content is somewhat out of date

Describe the solution you'd like

It would be great if someone could:

  1. Update the documentation with any changes
  2. Add it so it runs as part of the doc tests

Doc tests are run like this:

#[cfg(doctest)]
doc_comment::doctest!(
"../../../docs/source/library-user-guide/using-the-sql-api.md",
library_user_guide_sql_api
);

Test like

cargo test --doc

Describe alternatives you've considered

No response

Additional context

No response

@edmondop
Copy link
Contributor

take

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants