rluvaton commented on code in PR #25495: URL: https://github.com/apache/datafusion/pull/25495#discussion_r4069987399
########## docs/source/contributor-guide/api-health.md: ########## @@ -43,6 +43,35 @@ Examples of non-breaking changes include: - Marking a function as deprecated (`#[deprecated]`) - Adding a new function to a `trait` with a default implementation +### DataFusion-internal Public APIs + +Some internal implementation details require `pub` visibility because they are +shared across DataFusion crates. These APIs are not intended as downstream +extension points. They are hidden from generated documentation and are not part +of DataFusion's supported public API, so they may be changed or removed without +notice or a deprecation period. Examples include: + +1. Test helpers. +2. Operator APIs required by the optimizer to inspect or rewrite execution plans Review Comment: Nit: Please add another example - benchmarks, which was the original reason why `GroupColumn` was exposed and now people use it which complicate changing its api -- 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]
