Skip to content

Commit

Permalink
Small documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
otsaloma committed Dec 15, 2024
1 parent d3e9952 commit 64b5f36
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 12 deletions.
14 changes: 7 additions & 7 deletions doc/aggregation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,13 +103,13 @@ Going Fast with Numba

The common aggregation functions listed above are implemented in
Dataiter as both pure Python code (slow) and JIT-compiled `Numba
<https://numba.pydata.org/>`_ code (fast). If you have Numba installed
and importing it succeeds, then Dataiter will **automatically** use it
for aggregation involving **boolean**, **integer**, **float**, **date**,
and **datetime** columns. If Numba is not available, Dataiter will
automatically fall back on the slower pure Python implementations. The
result should be the same, whether Numba is used or not, excluding some
minor rounding or float precision differences.
<https://numba.pydata.org/>`_ code (fast). If you have Numba installed,
then Dataiter will **automatically** use it for aggregation involving
**boolean**, **integer**, **float**, **date**, and **datetime** columns.
If Numba is not available, Dataiter will automatically fall back on the
slower pure Python implementations. The result should be the same,
whether Numba is used or not, excluding some minor rounding or float
precision differences.

Numba is currently not a hard dependency of Dataiter, so you'll need to
install it separately::
Expand Down
6 changes: 3 additions & 3 deletions doc/comparison/blocks/chain-dplyr.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
data %>%
filter(year == 2021) %>%
arrange(desc(sales)) %>%
data |>
filter(year == 2021) |>
arrange(desc(sales)) |>
head(10)
3 changes: 1 addition & 2 deletions doc/comparison/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,7 @@ <h2>Chaining/Piping</h2>
<pre data-src="blocks/chain-dplyr.R"></pre>
<pre data-src="blocks/chain-dataiter.py"></pre>
<pre data-src="blocks/chain-pandas.py"></pre>
<p class="note">Since 4.1.0 R has a native pipe as well <code>|></code>, which is mostly
interchangeable with the above magrittr pipe.</p>
<p class="note"></p>
<p class="note"></p>
<p class="note">Pandas is not really designed for method chaining but it mostly works these
days. Note also that the "inplace" arguments that many methods take, which if used are
Expand Down

0 comments on commit 64b5f36

Please sign in to comment.