-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Tweak wording on a few pages. Make sure all the methods are documented. Use poetry groups for dependencies in noxfile.
- Loading branch information
1 parent
30e2dd4
commit 880936c
Showing
22 changed files
with
680 additions
and
269 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
_build | ||
.jupyter_cache | ||
jupyter_execute | ||
source/reference/**/api | ||
source/reference/apidocs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,7 +4,7 @@ | |
.. currentmodule:: sparrow_py | ||
.. autosummary:: | ||
:toctree: api/ | ||
:toctree: apidocs/ | ||
Result | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,22 @@ | ||
# Arithmetic | ||
|
||
Timestreams support a variety of arithmetic operations. | ||
|
||
```{note} | ||
Note: In addition to the chainable methods, standard operators are implemented where appropriate. | ||
For instance, `a.add(b)` may be written as `a + b`. | ||
See the notes on the specific functions for more information. | ||
``` | ||
|
||
```{eval-rst} | ||
.. currentmodule:: sparrow_py | ||
.. autosummary:: | ||
:toctree: api/ | ||
:toctree: ../apidocs/ | ||
Timestream.__add__ | ||
Timestream.__radd__ | ||
Timestream.__sub__ | ||
Timestream.__rsub__ | ||
Timestream.__mul__ | ||
Timestream.__rmul__ | ||
Timestream.__truediv__ | ||
Timestream.__rtruediv__ | ||
Timestream.add | ||
Timestream.sub | ||
Timestream.mul | ||
Timestream.div | ||
Timestream.neg | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Arithmetic | ||
|
||
Timestreams allow each point to contain a collection -- a `list` or `map` -- of elements. | ||
|
||
```{eval-rst} | ||
.. currentmodule:: sparrow_py | ||
.. autosummary:: | ||
:toctree: ../apidocs/ | ||
Timestream.__getitem__ | ||
Timestream.flatten | ||
Timestream.index | ||
Timestream.length | ||
Timestream.union | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Grouping | ||
|
||
```{eval-rst} | ||
.. currentmodule:: sparrow_py | ||
.. autosummary:: | ||
:toctree: ../apidocs/ | ||
Timestream.lookup | ||
Timestream.with_key | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,9 +14,12 @@ | |
aggregation | ||
arithmetic | ||
collection | ||
comparison | ||
execution | ||
grouping | ||
logical | ||
misc | ||
records | ||
time | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Time | ||
|
||
```{eval-rst} | ||
.. currentmodule:: sparrow_py | ||
.. autosummary:: | ||
:toctree: ../apidocs/ | ||
Timestream.shift_by | ||
Timestream.shift_to | ||
Timestream.shift_until | ||
Timestream.time_of | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,12 @@ | ||
# Windows | ||
|
||
```{eval-rst} | ||
.. currentmodule:: sparrow_py | ||
.. currentmodule:: sparrow_py.windows | ||
.. autosummary:: | ||
:toctree: api/ | ||
:toctree: apidocs/windows/ | ||
SinceWindow | ||
SlidingWindow | ||
Since | ||
Sliding | ||
Trailing | ||
``` |
Oops, something went wrong.