Skip to content

Commit

Permalink
Upgrade Documenter to 1.8 and add missing docstrings (#174)
Browse files Browse the repository at this point in the history
  • Loading branch information
@iamed2
iamed2 authored Dec 10, 2024
1 parent a24a92a commit b8b7720
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Project.toml
View file
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
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
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

2 comments on commit b8b7720

@kleinschmidt
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/121142

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.15.11 -m "<description of version>" b8b7720549c35cb57ee587b30a1b610065304253
git push origin v0.15.11

Please sign in to comment.