From 3e46aef392ba9b2e63bbfefefdb7178cc87049ab Mon Sep 17 00:00:00 2001
From: Ben Reynwar <ben@reynwar.net>
Date: Tue, 14 Aug 2012 07:12:53 -0700
Subject: docs: Changed arguments in python docstrings to new formatting style.
---
gr-uhd/examples/python/fm_tx4.py | 3 ++-
gr-uhd/examples/python/fm_tx_2_daughterboards.py | 5 +++--
gr-uhd/examples/python/usrp_am_mw_rcv.py | 3 ++-
gr-uhd/examples/python/usrp_nbfm_ptt.py | 6 ++++--
gr-uhd/examples/python/usrp_nbfm_rcv.py | 3 ++-
gr-uhd/examples/python/usrp_spectrum_sense.py | 3 ++-
gr-uhd/examples/python/usrp_tv_rcv.py | 3 ++-
gr-uhd/examples/python/usrp_wfm_rcv.py | 3 ++-
gr-uhd/examples/python/usrp_wfm_rcv_fmdet.py | 3 ++-
gr-uhd/examples/python/usrp_wfm_rcv_nogui.py | 3 ++-
gr-uhd/examples/python/usrp_wfm_rcv_pll.py | 3 ++-
gr-uhd/examples/python/usrp_wfm_rcv_sca.py | 3 ++-
gr-uhd/examples/python/usrp_wxapt_rcv.py | 3 ++-
13 files changed, 29 insertions(+), 15 deletions(-)
(limited to 'gr-uhd/examples/python')
diff --git a/gr-uhd/examples/python/fm_tx4.py b/gr-uhd/examples/python/fm_tx4.py
index f412ffb5dc..255b436f56 100755
--- a/gr-uhd/examples/python/fm_tx4.py
+++ b/gr-uhd/examples/python/fm_tx4.py
@@ -179,7 +179,8 @@ class fm_tx_block(stdgui2.std_top_block):
"""
Set the center frequency we're interested in.
- @param target_freq: frequency in Hz
+ Args:
+ target_freq: frequency in Hz
@rypte: bool
Tuning is a two step process. First we ask the front-end to
diff --git a/gr-uhd/examples/python/fm_tx_2_daughterboards.py b/gr-uhd/examples/python/fm_tx_2_daughterboards.py
index b5763e8e19..d98d655ab1 100755
--- a/gr-uhd/examples/python/fm_tx_2_daughterboards.py
+++ b/gr-uhd/examples/python/fm_tx_2_daughterboards.py
@@ -184,8 +184,9 @@ class my_top_block(gr.top_block):
"""
Set the center frequency we're interested in.
- @param side: 0 = side A, 1 = side B
- @param target_freq: frequency in Hz
+ Args:
+ side: 0 = side A, 1 = side B
+ target_freq: frequency in Hz
@rtype: bool
"""
diff --git a/gr-uhd/examples/python/usrp_am_mw_rcv.py b/gr-uhd/examples/python/usrp_am_mw_rcv.py
index 28262f2bd5..40a7fee68d 100755
--- a/gr-uhd/examples/python/usrp_am_mw_rcv.py
+++ b/gr-uhd/examples/python/usrp_am_mw_rcv.py
@@ -278,7 +278,8 @@ class wfm_rx_block (stdgui2.std_top_block):
"""
Set the center frequency we're interested in.
- @param target_freq: frequency in Hz
+ Args:
+ target_freq: frequency in Hz
@rypte: bool
"""
r = self.u.set_center_freq(target_freq + self.IF_freq, 0)
diff --git a/gr-uhd/examples/python/usrp_nbfm_ptt.py b/gr-uhd/examples/python/usrp_nbfm_ptt.py
index 8d26e656e1..af4c214795 100755
--- a/gr-uhd/examples/python/usrp_nbfm_ptt.py
+++ b/gr-uhd/examples/python/usrp_nbfm_ptt.py
@@ -344,7 +344,8 @@ class transmit_path(gr.hier_block2):
"""
Set the center frequency we're interested in.
- @param target_freq: frequency in Hz
+ Args:
+ target_freq: frequency in Hz
@rypte: bool
"""
r = self.u.set_center_freq(target_freq)
@@ -464,7 +465,8 @@ class receive_path(gr.hier_block2):
"""
Set the center frequency we're interested in.
- @param target_freq: frequency in Hz
+ Args:
+ target_freq: frequency in Hz
@rypte: bool
"""
r = self.u.set_center_freq(target_freq)
diff --git a/gr-uhd/examples/python/usrp_nbfm_rcv.py b/gr-uhd/examples/python/usrp_nbfm_rcv.py
index 571abe8c90..4a8340ec7b 100755
--- a/gr-uhd/examples/python/usrp_nbfm_rcv.py
+++ b/gr-uhd/examples/python/usrp_nbfm_rcv.py
@@ -357,7 +357,8 @@ class receive_path(gr.hier_block2):
"""
Set the center frequency we're interested in.
- @param target_freq: frequency in Hz
+ Args:
+ target_freq: frequency in Hz
@rypte: bool
"""
diff --git a/gr-uhd/examples/python/usrp_spectrum_sense.py b/gr-uhd/examples/python/usrp_spectrum_sense.py
index 32980adbfa..ce60241deb 100755
--- a/gr-uhd/examples/python/usrp_spectrum_sense.py
+++ b/gr-uhd/examples/python/usrp_spectrum_sense.py
@@ -213,7 +213,8 @@ class my_top_block(gr.top_block):
"""
Set the center frequency we're interested in.
- @param target_freq: frequency in Hz
+ Args:
+ target_freq: frequency in Hz
@rypte: bool
"""
r = self.u.set_center_freq(target_freq)
diff --git a/gr-uhd/examples/python/usrp_tv_rcv.py b/gr-uhd/examples/python/usrp_tv_rcv.py
index b49a5ea71a..b42cf57992 100755
--- a/gr-uhd/examples/python/usrp_tv_rcv.py
+++ b/gr-uhd/examples/python/usrp_tv_rcv.py
@@ -403,7 +403,8 @@ class tv_rx_block (stdgui2.std_top_block):
"""
Set the center frequency we're interested in.
- @param target_freq: frequency in Hz
+ Args:
+ target_freq: frequency in Hz
@rypte: bool
Tuning is a two step process. First we ask the front-end to
diff --git a/gr-uhd/examples/python/usrp_wfm_rcv.py b/gr-uhd/examples/python/usrp_wfm_rcv.py
index bbb5990337..a7d114d8cc 100755
--- a/gr-uhd/examples/python/usrp_wfm_rcv.py
+++ b/gr-uhd/examples/python/usrp_wfm_rcv.py
@@ -252,7 +252,8 @@ class wfm_rx_block (stdgui2.std_top_block):
"""
Set the center frequency we're interested in.
- @param target_freq: frequency in Hz
+ Args:
+ target_freq: frequency in Hz
@rypte: bool
"""
diff --git a/gr-uhd/examples/python/usrp_wfm_rcv_fmdet.py b/gr-uhd/examples/python/usrp_wfm_rcv_fmdet.py
index 514bd4faf7..b794825727 100755
--- a/gr-uhd/examples/python/usrp_wfm_rcv_fmdet.py
+++ b/gr-uhd/examples/python/usrp_wfm_rcv_fmdet.py
@@ -314,7 +314,8 @@ class wfm_rx_block (stdgui2.std_top_block):
"""
Set the center frequency we're interested in.
- @param target_freq: frequency in Hz
+ Args:
+ target_freq: frequency in Hz
@rypte: bool
"""
diff --git a/gr-uhd/examples/python/usrp_wfm_rcv_nogui.py b/gr-uhd/examples/python/usrp_wfm_rcv_nogui.py
index 7d042983ef..6e9c830c61 100755
--- a/gr-uhd/examples/python/usrp_wfm_rcv_nogui.py
+++ b/gr-uhd/examples/python/usrp_wfm_rcv_nogui.py
@@ -137,7 +137,8 @@ class wfm_rx_block (gr.top_block):
"""
Set the center frequency we're interested in.
- @param target_freq: frequency in Hz
+ Args:
+ target_freq: frequency in Hz
@rypte: bool
"""
diff --git a/gr-uhd/examples/python/usrp_wfm_rcv_pll.py b/gr-uhd/examples/python/usrp_wfm_rcv_pll.py
index 53b1e6feac..a5c78cb24b 100755
--- a/gr-uhd/examples/python/usrp_wfm_rcv_pll.py
+++ b/gr-uhd/examples/python/usrp_wfm_rcv_pll.py
@@ -311,7 +311,8 @@ class wfm_rx_block (stdgui2.std_top_block):
"""
Set the center frequency we're interested in.
- @param target_freq: frequency in Hz
+ Args:
+ target_freq: frequency in Hz
@rypte: bool
"""
diff --git a/gr-uhd/examples/python/usrp_wfm_rcv_sca.py b/gr-uhd/examples/python/usrp_wfm_rcv_sca.py
index 646fe85870..0e93e22fcd 100755
--- a/gr-uhd/examples/python/usrp_wfm_rcv_sca.py
+++ b/gr-uhd/examples/python/usrp_wfm_rcv_sca.py
@@ -357,7 +357,8 @@ class wfm_rx_sca_block (stdgui2.std_top_block):
"""
Set the center frequency we're interested in.
- @param target_freq: frequency in Hz
+ Args:
+ target_freq: frequency in Hz
@rypte: bool
Tuning is a two step process. First we ask the front-end to
diff --git a/gr-uhd/examples/python/usrp_wxapt_rcv.py b/gr-uhd/examples/python/usrp_wxapt_rcv.py
index 6b57de3bcf..5cceca1e98 100755
--- a/gr-uhd/examples/python/usrp_wxapt_rcv.py
+++ b/gr-uhd/examples/python/usrp_wxapt_rcv.py
@@ -247,7 +247,8 @@ class wxapt_rx_block (stdgui2.std_top_block):
"""
Set the center frequency we're interested in.
- @param target_freq: frequency in Hz
+ Args:
+ target_freq: frequency in Hz
@rypte: bool
"""
--
cgit v1.2.3