2010YOUY01 commented on code in PR #25678: URL: https://github.com/apache/datafusion/pull/25678#discussion_r4089195424
########## docs/source/contributor-guide/api-health.md: ########## @@ -51,24 +55,58 @@ 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 - across crate boundaries. +1. Test/micro-benchmark helpers. +2. Internal utilities, such as operator APIs required by the optimizer to inspect + or rewrite execution plans across crate boundaries. + +Note: Exposing internal APIs for tests or microbenchmarks is not recommended, Review Comment: This is somewhat subjective, I think it's not a good idea to test or benchmark against implementation details overall. I'm not so sure if there are any special cases that require this pattern. -- 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]
