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/sedona-db.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 7d79b8d Deployed 6cd31c1 to latest-snapshot with MkDocs 1.6.1 and
mike 2.1.3
7d79b8d is described below
commit 7d79b8d503222b688d0ff3d548b011efb1e064e1
Author: GitHub Actions <[email protected]>
AuthorDate: Sat Oct 25 05:43:28 2025 +0000
Deployed 6cd31c1 to latest-snapshot with MkDocs 1.6.1 and mike 2.1.3
---
latest-snapshot/contributors-guide/index.html | 57 ++++++++++++++++-----------
latest-snapshot/search/search_index.json | 2 +-
2 files changed, 35 insertions(+), 24 deletions(-)
diff --git a/latest-snapshot/contributors-guide/index.html
b/latest-snapshot/contributors-guide/index.html
index 2cf416a..6b91b80 100644
--- a/latest-snapshot/contributors-guide/index.html
+++ b/latest-snapshot/contributors-guide/index.html
@@ -961,6 +961,15 @@
</ul>
</nav>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#linting" class="md-nav__link">
+ <span class="md-ellipsis">
+ Linting
+ </span>
+ </a>
+
</li>
<li class="md-nav__item">
@@ -1373,6 +1382,15 @@
</ul>
</nav>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#linting" class="md-nav__link">
+ <span class="md-ellipsis">
+ Linting
+ </span>
+ </a>
+
</li>
<li class="md-nav__item">
@@ -1574,19 +1592,10 @@ native component with:</p>
</code></pre></div>
<h2 id="debugging">Debugging<a class="headerlink" href="#debugging"
title="Permanent link">¶</a></h2>
<h3 id="rust_1">Rust<a class="headerlink" href="#rust_1" title="Permanent
link">¶</a></h3>
-<p>Debugging Rust code is most easily done by writing or finding a test that
triggers
-the desired behavior and running it using the <em>Debug</em> selection in
-<a href="https://code.visualstudio.com/";>VSCode</a> with the
-<a
href="https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer";>rust-analyzer</a>
-extension. Rust code can also be debugged using the CLI by finding the
<code>main()</code> function in
+<p>Debugging Rust code is most easily done by writing or finding a test that
triggers the desired behavior and running it using the <em>Debug</em> selection
in <a href="https://code.visualstudio.com/";>VSCode</a> with the <a
href="https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer";>rust-analyzer</a>
extension. Rust code can also be debugged using the CLI by finding the
<code>main()</code> function in
<code>sedona-cli</code> and choosing the <em>Debug</em> run option.</p>
<h3 id="python-c-and-c">Python, C, and C++<a class="headerlink"
href="#python-c-and-c" title="Permanent link">¶</a></h3>
-<p>Installation of Python bindings with <code>maturin develop</code> ensures a
debug-friendly build for
-debugging Rust, Python, or C/C++ code. Python code can be debugged using
breakpoints in
-any IDE that supports debugging an editable Python package installation (e.g.,
VSCode);
-Rust, C, or C++ code can be debugged using the
-<a
href="https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb";>CodeLLDB</a>
-<em>Attach to Process...</em> command from the command palette in VSCode.</p>
+<p>Installation of Python bindings with <code>maturin develop</code> ensures a
debug-friendly build for debugging Rust, Python, or C/C++ code. Python code can
be debugged using breakpoints in any IDE that supports debugging an editable
Python package installation (e.g., VSCode); Rust, C, or C++ code can be
debugged using the <a
href="https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb";>CodeLLDB</a>
<em>Attach to Process...</em> command from the command palette in VSCode.</p>
<h2 id="testing">Testing<a class="headerlink" href="#testing" title="Permanent
link">¶</a></h2>
<h3 id="running-rust-tests">Running Rust tests<a class="headerlink"
href="#running-rust-tests" title="Permanent link">¶</a></h3>
<p>We use cargo to run the Rust tests.</p>
@@ -1604,26 +1613,28 @@ Rust, C, or C++ code can be debugged using the
<div class="highlight"><pre><span></span><code>pytest<span class="w">
</span>python/sedonadb/tests
</code></pre></div>
<p>Remember that you need to run <code>maturin develop</code> to update your
python installation after changes in Rust code.</p>
+<h2 id="linting">Linting<a class="headerlink" href="#linting" title="Permanent
link">¶</a></h2>
+<p>Install pre-commit. This will automatically run various checks (e.g
formatting) that will be needed to pass CI.</p>
+<div class="highlight"><pre><span></span><code>pre-commit<span class="w">
</span>install
+</code></pre></div>
+<p>If pre-commit is not already installed, you can install it using pip.</p>
+<div class="highlight"><pre><span></span><code>pip<span class="w">
</span>install<span class="w"> </span>pre-commit
+</code></pre></div>
+<p>Additionally, you should run clippy to catch common lints before pushing
new Rust changes. This is not included in <code>pre-commit</code>, so this
should be run manually. Fix any suggestions it makes, and run it again to make
sure there are no other changes to make.</p>
+<div class="highlight"><pre><span></span><code>cargo<span class="w">
</span>clippy
+</code></pre></div>
<h2 id="low-level-benchmarking">Low-level benchmarking<a class="headerlink"
href="#low-level-benchmarking" title="Permanent link">¶</a></h2>
-<p>Low-level Rust benchmarks use <a
href="https://github.com/bheisler/criterion.rs";>criterion</a>.
-In general, there is at least one benchmark for every implementation of a
function
-(some functions have more than one implementation provided by different
libraries),
-and a few other benchmarks for low-level iteration where work was done to
optimize
-specific cases.</p>
+<p>Low-level Rust benchmarks use <a
href="https://github.com/bheisler/criterion.rs";>criterion</a>. In general,
there is at least one benchmark for every implementation of a function (some
functions have more than one implementation provided by different libraries),
and a few other benchmarks for low-level iteration where work was done to
optimize specific cases.</p>
<h3 id="running-benchmarks">Running benchmarks<a class="headerlink"
href="#running-benchmarks" title="Permanent link">¶</a></h3>
<p>Benchmarks for a specific crate can be run with <code>cargo
bench</code>:</p>
<div class="highlight"><pre><span></span><code><span class="nb">cd</span><span
class="w"> </span>rust/sedona-geo
cargo<span class="w"> </span>bench
</code></pre></div>
-<p>Benchmarks for a specific function can be run with a filter. These can be
run
-from the workspace or a specific crate (although the output is usually easier
-to read for a specific crate).</p>
+<p>Benchmarks for a specific function can be run with a filter. These can be
run from the workspace or a specific crate (although the output is usually
easier to read for a specific crate).</p>
<div class="highlight"><pre><span></span><code>cargo<span class="w">
</span>bench<span class="w"> </span>--<span class="w"> </span>st_area
</code></pre></div>
<h3 id="managing-results">Managing results<a class="headerlink"
href="#managing-results" title="Permanent link">¶</a></h3>
-<p>By default, criterion saves the last run and will report the difference
between the
-current benchmark and the last time it was run (although there are options to
-save and load various baselines).</p>
+<p>By default, criterion saves the last run and will report the difference
between the current benchmark and the last time it was run (although there are
options to save and load various baselines).</p>
<p>A report of the latest results for all benchmarks can be opened with the
following command:</p>
<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input
checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio"><input
id="__tabbed_1_2" name="__tabbed_1" type="radio"><div
class="tabbed-labels"><label for="__tabbed_1_1">macOS</label><label
for="__tabbed_1_2">Ubuntu</label></div>
<div class="tabbed-content">
@@ -1676,7 +1687,7 @@ save and load various baselines).</p>
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 24 24"><path d="M21
13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6
0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4
2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10
9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1
7.5 7.1 7.9l-.1.2z"></path></svg>
</span>
- <span class="git-revision-date-localized-plugin
git-revision-date-localized-plugin-datetime" title="October 6, 2025 03:12:00
UTC">October 6, 2025 03:12:00</span>
+ <span class="git-revision-date-localized-plugin
git-revision-date-localized-plugin-datetime" title="October 25, 2025 05:38:25
UTC">October 25, 2025 05:38:25</span>
</span>
diff --git a/latest-snapshot/search/search_index.json
b/latest-snapshot/search/search_index.json
index 3008697..81e1889 100644
--- a/latest-snapshot/search/search_index.json
+++ b/latest-snapshot/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Introducing
SedonaDB","text":"<p>SedonaDB is an open-source single-node analytical
database engine with geospatial as a first-class citizen. It aims to deliver
the fastest spatial analytics query speed and the most comprehensive function
coverage available.</p> <p>SedonaDB is perfect for processing smaller to medium
datasets on local machines or cloud instances. For distributed [...]
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Introducing
SedonaDB","text":"<p>SedonaDB is an open-source single-node analytical
database engine with geospatial as a first-class citizen. It aims to deliver
the fastest spatial analytics query speed and the most comprehensive function
coverage available.</p> <p>SedonaDB is perfect for processing smaller to medium
datasets on local machines or cloud instances. For distributed [...]
\ No newline at end of file
