Skip to content

Commit 5caa0d2

Browse files
committed
Update index.rst
1 parent ae65ab5 commit 5caa0d2

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

docs/reference/decoder/index.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
Decoder
22
==========
33

4-
Get a list of samples from a cuplcodec URL
5-
-------------------------------------------
4+
Decode a cuplcodec URL
5+
------------------------
6+
7+
The decoder extracts a timestamped list of samples from a cuplcodec URL.
68

79
.. automodule:: wscodec.decoder.decoderfactory
810
:members:
@@ -25,7 +27,7 @@ Get a list of samples from a cuplcodec URL
2527
.. automodule:: wscodec.decoder.circularbuffer
2628
:members:
2729

28-
Samples
30+
Sample
2931
--------
3032

3133
.. inheritance-diagram:: wscodec.decoder.hdc2021.TempSample wscodec.decoder.hdc2021.TempRHSample
@@ -40,10 +42,10 @@ Samples
4042
.. autoclass:: wscodec.decoder.samples.Sample
4143
:members:
4244

43-
Pairs
45+
Pair
4446
-----
4547

46-
.. autoclass:: wscodec.decoder.pairs.Pairs
48+
.. autoclass:: wscodec.decoder.pairs.Pair
4749
:members:
4850

4951
Status

0 commit comments

Comments
 (0)