This is an automated email from the ASF dual-hosted git repository.
github-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 11ed21dfad Publish built docs triggered by
e70319fa2b1321fbcac16cf3fea85abd98a2b206
11ed21dfad is described below
commit 11ed21dfadd2baadb46e1cebee563709ea2e62e6
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Sun Dec 15 14:31:48 2024 +0000
Publish built docs triggered by e70319fa2b1321fbcac16cf3fea85abd98a2b206
---
_sources/library-user-guide/api-health.md.txt | 8 ++------
library-user-guide/api-health.html | 7 ++-----
searchindex.js | 2 +-
3 files changed, 5 insertions(+), 12 deletions(-)
diff --git a/_sources/library-user-guide/api-health.md.txt
b/_sources/library-user-guide/api-health.md.txt
index 46a894d4d5..b9c6de370e 100644
--- a/_sources/library-user-guide/api-health.md.txt
+++ b/_sources/library-user-guide/api-health.md.txt
@@ -31,7 +31,7 @@ APIs to give users time to adjust to the changes.
In general, a function is part of the public API if it appears on the [docs.rs
page]
Breaking public API changes are those that _require_ users to change their code
-for it to compile, and are listed as "Major Changes" in the [SemVer
+for it to compile and execute, and are listed as "Major Changes" in the [SemVer
Compatibility Section of the cargo book]. Common examples of breaking changes:
- Adding new required parameters to a function (`foo(a: i32, b: i32)` ->
`foo(a: i32, b: i32, c: i32)`)
@@ -57,11 +57,7 @@ version will be `44.0.0`.
[`cargo.toml`]: https://github.com/apache/datafusion/blob/main/Cargo.toml
-To mark the API as deprecated, use the `#[deprecated]` attribute like this:
-
-```rust
- #[deprecated(since = "...", note = "...")]
-```
+To mark the API as deprecated, use the `#[deprecated(since = "...", note =
"...")]` attribute.
For example:
diff --git a/library-user-guide/api-health.html
b/library-user-guide/api-health.html
index 24393cb304..846b2eb73b 100644
--- a/library-user-guide/api-health.html
+++ b/library-user-guide/api-health.html
@@ -570,7 +570,7 @@ APIs to give users time to adjust to the changes.</p>
<h2>Breaking Changes<a class="headerlink" href="#breaking-changes" title="Link
to this heading">¶</a></h2>
<p>In general, a function is part of the public API if it appears on the <a
class="reference external"
href="https://docs.rs/datafusion/latest/datafusion/index.html";>docs.rs
page</a></p>
<p>Breaking public API changes are those that <em>require</em> users to change
their code
-for it to compile, and are listed as “Major Changes” in the <a
class="reference external"
href="https://doc.rust-lang.org/cargo/reference/semver.html#change-categories";>SemVer
+for it to compile and execute, and are listed as “Major Changes” in the <a
class="reference external"
href="https://doc.rust-lang.org/cargo/reference/semver.html#change-categories";>SemVer
Compatibility Section of the cargo book</a>. Common examples of breaking
changes:</p>
<ul class="simple">
<li><p>Adding new required parameters to a function (<code class="docutils
literal notranslate"><span class="pre">foo(a:</span> <span
class="pre">i32,</span> <span class="pre">b:</span> <span
class="pre">i32)</span></code> -> <code class="docutils literal
notranslate"><span class="pre">foo(a:</span> <span class="pre">i32,</span>
<span class="pre">b:</span> <span class="pre">i32,</span> <span
class="pre">c:</span> <span class="pre">i32)</span></code>)</p></li>
@@ -590,10 +590,7 @@ the PR so we can highlight the changes in the release
notes.</p>
<p>The deprecated version is the next version which contains the deprecation.
For
example, if the current version listed in <a class="reference external"
href="https://github.com/apache/datafusion/blob/main/Cargo.toml";><code
class="docutils literal notranslate"><span
class="pre">Cargo.toml</span></code></a> is <code class="docutils literal
notranslate"><span class="pre">43.0.0</span></code> then the next
version will be <code class="docutils literal notranslate"><span
class="pre">44.0.0</span></code>.</p>
-<p>To mark the API as deprecated, use the <code class="docutils literal
notranslate"><span class="pre">#[deprecated]</span></code> attribute like
this:</p>
-<div class="highlight-rust notranslate"><div
class="highlight"><pre><span></span><span class="w"> </span><span
class="cp">#[deprecated(since = </span><span
class="s">"..."</span><span class="cp">, note = </span><span
class="s">"..."</span><span class="cp">)]</span>
-</pre></div>
-</div>
+<p>To mark the API as deprecated, use the <code class="docutils literal
notranslate"><span class="pre">#[deprecated(since</span> <span
class="pre">=</span> <span class="pre">"...",</span> <span
class="pre">note</span> <span class="pre">=</span> <span
class="pre">"...")]</span></code> attribute.</p>
<p>For example:</p>
<div class="highlight-rust notranslate"><div
class="highlight"><pre><span></span><span class="w"> </span><span
class="cp">#[deprecated(since = </span><span
class="s">"41.0.0"</span><span class="cp">, note = </span><span
class="s">"Use SessionStateBuilder"</span><span class="cp">)]</span>
<span class="w"> </span><span class="k">pub</span><span class="w">
</span><span class="k">fn</span><span class="w"> </span><span
class="nf">new_with_config_rt</span><span class="p">(</span><span
class="n">config</span><span class="p">:</span><span class="w"> </span><span
class="nc">SessionConfig</span><span class="p">,</span><span class="w">
</span><span class="n">runtime</span><span class="p">:</span><span class="w">
</span><span class="nc">Arc</span><span class="o"><</span><span [...]
diff --git a/searchindex.js b/searchindex.js
index cb07945a50..db6a61fc06 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"!=": [[48, "op-neq"]], "!~": [[48,
"op-re-not-match"]], "!~*": [[48, "op-re-not-match-i"]], "!~~": [[48, "id18"]],
"!~~*": [[48, "id19"]], "#": [[48, "op-bit-xor"]], "%": [[48, "op-modulo"]],
"&": [[48, "op-bit-and"]], "(relation, name) tuples in logical fields and
logical columns are unique": [[9,
"relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]], "*":
[[48, "op-multiply"]], "+": [[48, "op-plus"]], "-": [[48, "op-minus"]], "/":
[[4 [...]
\ No newline at end of file
+Search.setIndex({"alltitles": {"!=": [[48, "op-neq"]], "!~": [[48,
"op-re-not-match"]], "!~*": [[48, "op-re-not-match-i"]], "!~~": [[48, "id18"]],
"!~~*": [[48, "id19"]], "#": [[48, "op-bit-xor"]], "%": [[48, "op-modulo"]],
"&": [[48, "op-bit-and"]], "(relation, name) tuples in logical fields and
logical columns are unique": [[9,
"relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]], "*":
[[48, "op-multiply"]], "+": [[48, "op-plus"]], "-": [[48, "op-minus"]], "/":
[[4 [...]
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
