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

Improvement: move rustdoc example for to_date() function to examples and provide an updated rustdoc for the function #9416

Open
Omega359 opened this issue Mar 1, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@Omega359
Copy link
Contributor

Omega359 commented Mar 1, 2024

Is your feature request related to a problem or challenge?

Unfortunately because of limitations with rustdoc and cyclical dependencies we cannot have a fully working example in the rustdoc for the newly migrated to_date function (SessionContext is not visible and cannot be brought in as a dev dependency because of #9277). Thus, if we want to have fully working examples for functions like this one we'll need to put them into examples somewhere (datafusion-examples comes to mind) and ideally link to that example from within the rustdoc.

Describe the solution you'd like

ignored rustdoc example moved to a working examples location and rustdoc for to_date updated with new documentation and a link to the fully working example. Must work when docs are published externally, not just from source view.

Describe alternatives you've considered

leave as is or remove :(

Additional context

No response

@Omega359 Omega359 added the enhancement New feature or request label Mar 1, 2024
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

1 participant