alamb opened a new pull request, #10406: URL: https://github.com/apache/datafusion/pull/10406
## Which issue does this PR close? Part of #7013 ## Rationale for this change I have had to look up the behavior of this function several times when working on optimizer rules, so I would like to better document it ## What changes are included in this PR? 1. add doc comments + examples ## Are these changes tested? Doc CI check <!-- We typically require tests for all PRs in order to: 1. Prevent the code from being accidentally broken by subsequent changes 3. Serve as another way to document the expected behavior of the code If tests are not included in your PR, please explain why (for example, are they covered by existing tests)? --> ## Are there any user-facing changes? Better docs <!-- If there are user-facing changes then we may require documentation to be updated before approving the PR. --> <!-- If there are any breaking changes to public APIs, please add the `api change` label. --> -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
