You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datafusion.apache.org by gi...@apache.org on 2026/10/10 02:43:16 UTC
(datafusion) branch asf-site updated: Publish built docs triggered by 4e6e564e586f37457316ab4bef74a9766716f6a9
This is an automated email from the ASF dual-hosted git repository.
github-actions[bot] pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/datafusion.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 53b15dd30f Publish built docs triggered by 4e6e564e586f37457316ab4bef74a9766716f6a9
53b15dd30f is described below
commit 53b15dd30f90ac205a831f8acc48f925299f9b0e
Author: github-actions[bot] <gi...@users.noreply.github.com>
AuthorDate: Sat Oct 10 02:43:11 2026 +0000
Publish built docs triggered by 4e6e564e586f37457316ab4bef74a9766716f6a9
---
_sources/contributor-guide/api-health.md.txt | 12 ++++++------
contributor-guide/api-health.html | 12 ++++++------
searchindex.js | 2 +-
3 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/_sources/contributor-guide/api-health.md.txt b/_sources/contributor-guide/api-health.md.txt
index e74d74ea51..d5452dd09e 100644
--- a/_sources/contributor-guide/api-health.md.txt
+++ b/_sources/contributor-guide/api-health.md.txt
@@ -63,18 +63,18 @@ Do not expose internal APIs solely for tests or microbenchmarks. Some legacy cod
does so, but new tests and benchmarks should exercise observable behavior to
simplify maintenance.
-For APIs intended only for internal use, add `#[doc(hidden)]` and a doc comment
-section headed `# Public Only for Internal Use:`. Name the crate or component
-that requires access and explain why the API is not intended for downstream use.
-For example:
+For APIs intended only for internal use, add `#[doc(hidden)]` and use the
+following doc comment format, including the API policy link:
```txt
impl HashTableLookupExpr {
/// ...
///
/// # Public Only for Internal Use:
- /// `datafusion-proto` tests require this constructor, but it is not part of
- /// the supported public API.
+ ///
+ /// This is not a public API and is for internal use only; see [API policy] for details.
+ ///
+ /// [API policy]: https://datafusion.apache.org/contributor-guide/api-health.html#internal-public-apis
#[doc(hidden)]
pub fn new(...) {...}
}
diff --git a/contributor-guide/api-health.html b/contributor-guide/api-health.html
index d3b86c4faf..3226f9f590 100644
--- a/contributor-guide/api-health.html
+++ b/contributor-guide/api-health.html
@@ -490,16 +490,16 @@ across crate boundaries.</p></li>
<p>Do not expose internal APIs solely for tests or microbenchmarks. Some legacy code
does so, but new tests and benchmarks should exercise observable behavior to
simplify maintenance.</p>
-<p>For APIs intended only for internal use, add <code class="docutils literal notranslate"><span class="pre">#[doc(hidden)]</span></code> and a doc comment
-section headed <code class="docutils literal notranslate"><span class="pre">#</span> <span class="pre">Public</span> <span class="pre">Only</span> <span class="pre">for</span> <span class="pre">Internal</span> <span class="pre">Use:</span></code>. Name the crate or component
-that requires access and explain why the API is not intended for downstream use.
-For example:</p>
+<p>For APIs intended only for internal use, add <code class="docutils literal notranslate"><span class="pre">#[doc(hidden)]</span></code> and use the
+following doc comment format, including the API policy link:</p>
<div class="highlight-txt notranslate"><div class="highlight"><pre><span></span>impl HashTableLookupExpr {
/// ...
///
/// # Public Only for Internal Use:
- /// `datafusion-proto` tests require this constructor, but it is not part of
- /// the supported public API.
+ ///
+ /// This is not a public API and is for internal use only; see [API policy] for details.
+ ///
+ /// [API policy]: https://datafusion.apache.org/contributor-guide/api-health.html#internal-public-apis
#[doc(hidden)]
pub fn new(...) {...}
}
diff --git a/searchindex.js b/searchindex.js
index fa49396014..dd7bb6cc97 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles":{"!=":[[79,"op-neq"]],"!~":[[79,"op-re-not-match"]],"!~*":[[79,"op-re-not-match-i"]],"!~~":[[79,"id19"]],"!~~*":[[79,"id20"]],"#":[[79,"op-bit-xor"]],"%":[[79,"op-modulo"]],"&":[[79,"op-bit-and"]],"(relation, name) tuples in logical fields and logical columns are unique":[[17,"relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]],"*":[[79,"op-multiply"]],"+":[[79,"op-plus"]],"-":[[79,"op-minus"]],"/":[[79,"op-divide"]],"1. Array Literal Con [...]
\ No newline at end of file
+Search.setIndex({"alltitles":{"!=":[[79,"op-neq"]],"!~":[[79,"op-re-not-match"]],"!~*":[[79,"op-re-not-match-i"]],"!~~":[[79,"id19"]],"!~~*":[[79,"id20"]],"#":[[79,"op-bit-xor"]],"%":[[79,"op-modulo"]],"&":[[79,"op-bit-and"]],"(relation, name) tuples in logical fields and logical columns are unique":[[17,"relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]],"*":[[79,"op-multiply"]],"+":[[79,"op-plus"]],"-":[[79,"op-minus"]],"/":[[79,"op-divide"]],"1. Array Literal Con [...]
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datafusion.apache.org
For additional commands, e-mail: commits-help@datafusion.apache.org