Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade Documenter to 1.8 and add missing docstrings #174

Merged
merged 3 commits into from
Dec 10, 2024
Merged

Upgrade Documenter to 1.8 and add missing docstrings #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e208f2a
Upgrade to Documenter 1.8
iamed2 Dec 10, 2024
cd605f0
Add missing docstrings
iamed2 Dec 10, 2024
8f311e6
Bump version to 0.15.11
iamed2 Dec 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "Onda"
uuid = "e853f5be-6863-11e9-128d-476edb89bfb5"
authors = ["Beacon Biosignals, Inc."]
version = "0.15.10"
version = "0.15.11"

[deps]
Arrow = "69666777-d1a9-59fb-9406-91d4454c9d45"
Expand Down
2 changes: 1 addition & 1 deletion docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
Onda = "e853f5be-6863-11e9-128d-476edb89bfb5"

[compat]
Documenter = "0.27"
Documenter = "1.8"
5 changes: 5 additions & 0 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Onda.read_byte_range
AnnotationV1
MergedAnnotationV1
merge_overlapping_annotations
validate_annotations
```

## `onda.signal`
Expand All @@ -38,13 +39,16 @@ channel_count(x)
sample_count(x, duration::Period)
sizeof_samples(x, duration::Period)
sample_type(x)
validate_signals
```

## `Samples`

```@docs
Samples
==(::Samples, ::Samples)
isequal(::Samples, ::Samples)
copy(::Samples)
channel
channel_count
sample_count
Expand All @@ -59,6 +63,7 @@ channel(samples::Samples, name)
channel(samples::Samples, i::Integer)
channel_count(samples::Samples)
sample_count(samples::Samples)
Onda.validate_samples
```

## LPCM (De)serialization API
Expand Down
Loading