Skip to content

Commit

Permalink
blocks/sources: fix unit prefix in docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
vsergeev committed Jul 2, 2016
1 parent c0f71ef commit c970fbb
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion radio/blocks/sources/iqfile.lua
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
-- -- Source little-endian 32-bit IQ samples from a file sampled at 1 MHz, repeating on EOF
-- local src = radio.IQFileSource('samples.f32le.iq', 'f32le', 1e6, true)
--
-- -- Source little-endian signed 16-bit IQ samples from stdin sampled at 500 KHz
-- -- Source little-endian signed 16-bit IQ samples from stdin sampled at 500 kHz
-- local src = radio.IQFileSource(io.stdin, 's16le', 500e3)

local ffi = require('ffi')
Expand Down
4 changes: 2 additions & 2 deletions radio/blocks/sources/null.lua
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@
-- -- Source a zero complex-valued signal sampled at 1 MHz
-- local src = radio.NullSource(radio.types.ComplexFloat32, 1e6)
--
-- -- Source a zero real-valued stream sampled at 500 KHz
-- -- Source a zero real-valued stream sampled at 500 kHz
-- local src = radio.NullSource(radio.types.Bit, 500e3)
--
-- -- Source a zero bit stream sampled at 2 KHz
-- -- Source a zero bit stream sampled at 2 kHz
-- local src = radio.NullSource(radio.types.Bit, 2e3)

local block = require('radio.core.block')
Expand Down
2 changes: 1 addition & 1 deletion radio/blocks/sources/rawfile.lua
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
-- -- Source ComplexFloat32 samples sampled at 1 MHz from a file descriptor
-- local src = radio.RawFileSource(3, radio.types.ComplexFloat32, 1e6)
--
-- -- Source Byte samples sampled at 100 KHz from a file, repeating on EOF
-- -- Source Byte samples sampled at 100 kHz from a file, repeating on EOF
-- local src = radio.RawFileSource('data.bin', radio.types.Byte, 100e3, true)

local ffi = require('ffi')
Expand Down
2 changes: 1 addition & 1 deletion radio/blocks/sources/realfile.lua
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
-- -- Source little-endian 32-bit real samples from a file sampled at 1 MHz, repeating on EOF
-- local src = radio.RealFileSource('samples.f32le.real', 'f32le', 1e6, true)
--
-- -- Source little-endian signed 16-bit real samples from stdin sampled at 500 KHz
-- -- Source little-endian signed 16-bit real samples from stdin sampled at 500 kHz
-- local src = radio.RealFileSource(0, 's16le', 500e3)

local ffi = require('ffi')
Expand Down
6 changes: 3 additions & 3 deletions radio/blocks/sources/signal.lua
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@
-- @signature > out:Float32
--
-- @usage
-- -- Source a 250 KHz complex exponential sampled at 2 MHz
-- -- Source a 250 kHz complex exponential sampled at 2 MHz
-- local src = radio.SignalSource('exponential', 250e3, 2e6)
--
-- -- Source a 100 KHz cosine sampled at 1 MHz, with amplitude 2.5
-- -- Source a 100 kHz cosine sampled at 1 MHz, with amplitude 2.5
-- local src = radio.SignalSource('cosine', 100e3, 1e6, {amplitude = 2.5})
--
-- -- Source a 1 KHz square wave sampled at 2 MHz, with offset 1.0
-- -- Source a 1 kHz square wave sampled at 2 MHz, with offset 1.0
-- local src = radio.SignalSource('square', 1e3, 2e6, {offset = 1.0})

local ffi = require('ffi')
Expand Down
4 changes: 2 additions & 2 deletions radio/blocks/sources/uniformrandom.lua
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@
-- -- Source a random Float32 signal sampled at 1 MHz
-- local src = radio.UniformRandomSource(radio.types.Float32, 1e6)
--
-- -- Source a random Byte signal sampled at 1 KHz, ranging from 65 to 90
-- -- Source a random Byte signal sampled at 1 kHz, ranging from 65 to 90
-- local src = radio.UniformRandomSource(radio.types.Byte, 1e3, {65, 90})
--
-- -- Source a random bit stream sampled at 1 KHz
-- -- Source a random bit stream sampled at 1 kHz
-- local src = radio.UniformRandomSource(radio.types.Bit, 1e3)

local math = require('math')
Expand Down

0 comments on commit c970fbb

Please sign in to comment.