Skip to content

Commit

Permalink
Fix for misc. documentation + trivial typos
Browse files Browse the repository at this point in the history
Found via `codespell -q 3 -L ans,sinc,hist,ist,ith,uint,fo -S ./volk`
Fix typos in gnuradio-runtime/
Fix typos in gr-digital/
Fix typos in gr-qtgui/
Fix typos in gr-channels/
Fix typos in grc/
Fix typos gr-filter/
Fix typos in gr-uhd/
Fix typos in gr-blocks/
Fix typos in gr-fec/
  • Loading branch information
luzpaz authored and marcusmueller committed Jul 17, 2019
1 parent 1545240 commit 925e110
Show file tree
Hide file tree
Showing 55 changed files with 59 additions and 59 deletions.
2 changes: 1 addition & 1 deletion cmake/Modules/GrBuildTypes.cmake
Expand Up @@ -50,7 +50,7 @@ list(APPEND AVAIL_BUILDTYPES
# known build types in AVAIL_BUILDTYPES. If the build type is found,
# the function exits immediately. If nothing is found by the end of
# checking all available build types, we exit with an error and list
# the avialable build types.
# the available build types.
########################################################################
function(GR_CHECK_BUILD_TYPE settype)
STRING(TOUPPER ${settype} _settype)
Expand Down
2 changes: 1 addition & 1 deletion docs/RELEASE-NOTES-3.7.10.1.md
Expand Up @@ -48,7 +48,7 @@ Fix VL-SNR framing.

### Digital

Enable update rate in block_recovery_mm blocks to keep tags close to the the proper clock-recovered sample time. Tag offsets will still be off between calls to work, but each work call updates the tag rate.
Enable update rate in block_recovery_mm blocks to keep tags close to the proper clock-recovered sample time. Tag offsets will still be off between calls to work, but each work call updates the tag rate.

### Analog

Expand Down
2 changes: 1 addition & 1 deletion docs/doxygen/other/build_guide.dox.in
Expand Up @@ -153,7 +153,7 @@ built or installed.

The -DENABLE_DEFAULT=False can be used to disable all
components. Individual components can then be selectively turned back
on. For example, just buidling the VOLK library can be
on. For example, just building the VOLK library can be
done with this:

\code
Expand Down
2 changes: 1 addition & 1 deletion gnuradio-runtime/include/gnuradio/block.h
Expand Up @@ -177,7 +177,7 @@ namespace gr {
*
* WORK_CALLED_PRODUCE is used where not all outputs produce the
* same number of items. general_work must call produce() for each
* output to indicate the numer of items actually produced.
* output to indicate the number of items actually produced.
*
* WORK_DONE indicates that no more data will be produced by this block.
*
Expand Down
2 changes: 1 addition & 1 deletion gnuradio-runtime/include/gnuradio/logger.h
Expand Up @@ -301,7 +301,7 @@ namespace gr {
printf("Set string was:%s\n", set.c_str());
}

/*! \brief destrcutor stops watch thread before exits */
/*! \brief destructor stops watch thread before exits */
~logger_config() {
stop_watch();
}
Expand Down
2 changes: 1 addition & 1 deletion gnuradio-runtime/include/gnuradio/rpcregisterhelpers.h
Expand Up @@ -1452,7 +1452,7 @@ class rpcbasic_register_handler : public rpcbasic_base
* \brief Adds the ability to pass a message over ControlPort.
*
* \details
* This makes any message handler function avialable over
* This makes any message handler function available over
* ControlPort. Since message handlers always take in a single PMT
* message input, this interface provides a very generic way of
* setting values in a block in a flowgraph.
Expand Down
2 changes: 1 addition & 1 deletion gnuradio-runtime/lib/logger.cc
Expand Up @@ -92,7 +92,7 @@ namespace gr {
}
}

// Method to load the confifuration. It only loads if the filename
// Method to load the configuration. It only loads if the filename
// or watch has changed
void
logger_config::load_config(std::string filename,unsigned int watch_period)
Expand Down
2 changes: 1 addition & 1 deletion gnuradio-runtime/python/gnuradio/gr/gateway.py
Expand Up @@ -95,7 +95,7 @@ def __init__(self, min_ports, max_ports, type_list):
"""
Args:
min_ports (int): mininum number of connected ports.
min_ports (int): minimum number of connected ports.
max_ports (int): maximum number of connected ports. -1 indicates
no limit.
Expand Down
4 changes: 2 additions & 2 deletions gnuradio-runtime/python/gnuradio/gr/top_block.py
Expand Up @@ -44,15 +44,15 @@ class _top_block_waiter(threading.Thread):
thread), we create a separate thread that does the blocking wait,
and then use the thread that called wait to do a slow poll of an
event queue. That thread, which is executing "wait" below is
interruptable, and if it sees a KeyboardInterrupt, executes a stop
interruptible, and if it sees a KeyboardInterrupt, executes a stop
on the top_block, then goes back to waiting for it to complete.
This ensures that the unlocked wait that was in progress (in the
_top_block_waiter thread) can complete, release its mutex and back
out. If we don't do that, we are never able to clean up, and nasty
things occur like leaving the USRP transmitter sending a carrier.
See also top_block.wait (below), which uses this class to implement
the interruptable wait.
the interruptible wait.
"""
def __init__(self, tb):
threading.Thread.__init__(self)
Expand Down
2 changes: 1 addition & 1 deletion gnuradio-runtime/python/gnuradio/gru/freqz.py
Expand Up @@ -120,7 +120,7 @@ class poly1d(object):
p[k] is the coefficient on the kth power of x (backwards from
sequencing the coefficient array.
polynomials can be added, substracted, multiplied and divided (returns
polynomials can be added, subtracted, multiplied and divided (returns
quotient and remainder).
asarray(p) will also give the coefficient array, so polynomials can
be used in all functions that accept arrays.
Expand Down
2 changes: 1 addition & 1 deletion gnuradio-runtime/swig/gnuradio.i
Expand Up @@ -75,7 +75,7 @@
%include <gnuradio/high_res_timer.h>

////////////////////////////////////////////////////////////////////////
// Python 2/3 compatibilty
// Python 2/3 compatibility

%begin %{
#define SWIG_PYTHON_2_UNICODE
Expand Down
2 changes: 1 addition & 1 deletion gr-blocks/grc/blocks_message_strobe_random.block.yml
Expand Up @@ -46,6 +46,6 @@ documentation: |-
Please note some peculiarities below:
- poisson does not care about your std
- gaussian operates as expected
- uniform is actually of the range (mean-std, mean+std) - thus we are lieing and it is not actually an std here
- uniform is actually of the range (mean-std, mean+std) - thus we are lying and it is not actually an std here
file_format: 1
2 changes: 1 addition & 1 deletion gr-blocks/grc/blocks_vector_insert_x.block.yml
Expand Up @@ -45,6 +45,6 @@ documentation: |-
Periodicity, the length of the periodicity at which the vector should be inserted at the output.
(i.e. one vector for every N output items)
Offset sepcifies where in the cycle period we should begin at.
Offset specifies where in the cycle period we should begin at.
file_format: 1
4 changes: 2 additions & 2 deletions gr-blocks/include/gnuradio/blocks/control_loop.h
Expand Up @@ -33,7 +33,7 @@ namespace gr {
*
* \details
* This class implements a second order control loop and is
* inteded to act as a parent class to blocks which need a control
* intended to act as a parent class to blocks which need a control
* loop (e.g., gr::digital::costas_loop_cc,
* gr::analog::pll_refout_cc, etc.). It takes in a loop bandwidth
* as well as a max and min frequency and provides the functions
Expand Down Expand Up @@ -326,7 +326,7 @@ namespace gr {
/*!
* A look-up table (LUT) tanh calcuation. This function returns an
* estimate to tanh(x) based on a 256-point LUT between -2 and
* 2. If x < -2, it returns -1; if > 2, it retursn 1.
* 2. If x < -2, it returns -1; if > 2, it returns 1.
*
* This LUT form of the tanh is "hidden" in this code because it
* is likely too coarse an estimate for any real uses of a
Expand Down
2 changes: 1 addition & 1 deletion gr-blocks/include/gnuradio/blocks/tcp_server_sink.h
Expand Up @@ -30,7 +30,7 @@ namespace gr {
namespace blocks {

/*!
* \brief Send stream trought an TCP socket.
* \brief Send stream through a TCP socket.
* \ingroup networking_tools_blk
*
* \details
Expand Down
2 changes: 1 addition & 1 deletion gr-blocks/lib/udp_source_impl.cc
Expand Up @@ -186,7 +186,7 @@ namespace gr {

// Use async receive_from to get data from UDP buffer and wait
// on a conditional signal before proceeding. We use this
// because the conditional wait is interruptable while a
// because the conditional wait is interruptible while a
// synchronous receive_from is not.
boost::unique_lock<boost::mutex> lock(d_udp_mutex);

Expand Down
2 changes: 1 addition & 1 deletion gr-channels/grc/channels_iqbal_gen.block.yml
Expand Up @@ -56,7 +56,7 @@ documentation: |-
|
+--X2

X1--|Multply: 10**(mag/20)|--{R}--| Float 2 |--- Output
X1--|Multiply: 10**(mag/20)|--{R}--| Float 2 |--- Output
X2--------------------------------------------{I}--| Complex |

(ASCII ART adjusted for GRC viewing)
Expand Down
2 changes: 1 addition & 1 deletion gr-channels/grc/channels_selective_fading_model2.block.yml
Expand Up @@ -86,7 +86,7 @@ documentation: |-
Compact Rayleigh and Rician fading simulator based on random walk processes
A. Alimohammad S.F. Fard B.F. Cockburn C. Schlegel
26th November 2008
(Alogrithm III)
(Algorithm III)
( with a novel addition of time delay tap random walk )
The frequency selective extension of the block roughly implements
Expand Down
Expand Up @@ -39,7 +39,7 @@ namespace gr {
* be used to help evaluate, design, and test various signals,
* waveforms, and algorithms.
*
* This model allows the user to set up an AWGN noise cource, a
* This model allows the user to set up an AWGN noise source, a
* random walk process to simulate carrier frequency drift, a random
* walk process to simulate sample rate offset drive, and a frequency
* selective fading channel response that is either Rayleigh or Ricean
Expand Down
2 changes: 1 addition & 1 deletion gr-channels/python/channels/iqbal_gen.py
Expand Up @@ -42,7 +42,7 @@ def __init__(self, magnitude=0, phase=0, mode=0):
|
+--X2
X1--|Multply: 10**(mag/20)|--{R}--| Float 2 |--- Output
X1--|Multiply: 10**(mag/20)|--{R}--| Float 2 |--- Output
X2---------------------------{I}--| Complex |
(ASCII ART monospace viewing)
Expand Down
2 changes: 1 addition & 1 deletion gr-digital/include/gnuradio/digital/corr_est_cc.h
Expand Up @@ -71,7 +71,7 @@ namespace gr {
* know where the actual sync word symbols are located relative to
* "corr_start", given that some modulations have pulses with
* intentional ISI. The user should manually examine the primary
* output and the "corr_start" tag postition to determine the
* output and the "corr_start" tag position to determine the
* required tag delay settings for the particular modulation,
* sync word, and downstream blocks used.
*
Expand Down
2 changes: 1 addition & 1 deletion gr-digital/include/gnuradio/digital/diff_decoder_bb.h
Expand Up @@ -44,7 +44,7 @@ namespace gr {
typedef boost::shared_ptr<diff_decoder_bb> sptr;

/*!
* Make a differntial decoder block.
* Make a differential decoder block.
*
* \param modulus Modulus of code's alphabet
*/
Expand Down
2 changes: 1 addition & 1 deletion gr-digital/include/gnuradio/digital/diff_encoder_bb.h
Expand Up @@ -44,7 +44,7 @@ namespace gr {
typedef boost::shared_ptr<diff_encoder_bb> sptr;

/*!
* Make a differntial encoder block.
* Make a differential encoder block.
*
* \param modulus Modulus of code's alphabet
*/
Expand Down
2 changes: 1 addition & 1 deletion gr-digital/include/gnuradio/digital/fll_band_edge_cc.h
Expand Up @@ -65,7 +65,7 @@ namespace gr {
* derivative of a cosine is a sine). Extend this sine by another
* quarter wave to make a half wave around the band-edges is
* equivalent in time to the sum of two sinc functions. The
* baseband filter fot the band edges is therefore derived from
* baseband filter for the band edges is therefore derived from
* this sum of sincs. The band edge filters are then just the
* baseband signal modulated to the correct place in
* frequency. All of these calculations are done in the
Expand Down
2 changes: 1 addition & 1 deletion gr-digital/lib/clock_tracking_loop.h
Expand Up @@ -31,7 +31,7 @@ namespace gr {
*
* \details
* This class implements most of a second order symbol clock
* tracking loop and is inteded to act as a parent class to blocks
* tracking loop and is intended to act as a parent class to blocks
* which need a symbol clock tracking loop to determine the optimal
* instant to sample a received symbol from an input sample
* stream (i.e. *_clock_recovery* and *_clock_sync* blocks).
Expand Down
2 changes: 1 addition & 1 deletion gr-digital/python/digital/digital_voice.py.real
Expand Up @@ -51,7 +51,7 @@ AIR_FRAME_SIZE = 70

class digital_voice_tx(gr.hier_block):
"""
Hierarchical block for digital voice tranmission.
Hierarchical block for digital voice transmission.
The input is 8kS/sec floating point audio in the range [-1,+1]
The output is 256kS/sec GMSK modulated complex baseband signal in the range [-1,+1].
Expand Down
2 changes: 1 addition & 1 deletion gr-digital/python/digital/ofdm_receiver.py
Expand Up @@ -45,7 +45,7 @@ class ofdm_receiver(gr.hier_block2):
The receiver performs channel filtering as well as symbol, frequency, and phase synchronization.
The synchronization routines are available in three flavors: preamble correlator (Schmidl and Cox),
modifid preamble correlator with autocorrelation (not yet working), and cyclic prefix correlator
modified preamble correlator with autocorrelation (not yet working), and cyclic prefix correlator
(Van de Beeks).
"""

Expand Down
2 changes: 1 addition & 1 deletion gr-digital/python/digital/qa_constellation.py
Expand Up @@ -37,7 +37,7 @@
# Second item is a dictionary of arguments for function with lists of
# possible values.
# Third item is whether differential encoding should be tested.
# Fourth item is the name of the argument to constructor that specifices
# Fourth item is the name of the argument to constructor that specifies
# whether differential encoding is used.

def twod_constell():
Expand Down
2 changes: 1 addition & 1 deletion gr-digital/python/digital/soft_dec_lut_gen.py
Expand Up @@ -188,7 +188,7 @@ def calc_soft_dec(sample, constel, symbols, npwr=1):
If known, the noise power of the received sample may be passed in
to this function as npwr.
This is an incredibly costly algorthm because it must calculate
This is an incredibly costly algorithm because it must calculate
the Euclidean distance between the sample and all points in the
constellation to build up its probability
calculations. Conversely, it should work for any given
Expand Down
2 changes: 1 addition & 1 deletion gr-digital/python/digital/utils/gray_code.py
Expand Up @@ -33,7 +33,7 @@ def __init__(self):
self.lp2 = 2
# The next power of two that will be passed through.
self.np2 = 4
# Curent index
# Current index
self.i = 2

def get_gray_code(self, length):
Expand Down
2 changes: 1 addition & 1 deletion gr-fec/grc/fec_decoder.block.yml
Expand Up @@ -36,6 +36,6 @@ templates:
make: fec.decoder(${decoder}, ${itype.size}, ${otype.size})

documentation: |-
This is a GNU Radio adaptor for any FEC decoder following the generic_decoder API in the fec module. Input and output are flexible to accomodate decoders that, say, modulate their encoded results into complex or float types.
This is a GNU Radio adaptor for any FEC decoder following the generic_decoder API in the fec module. Input and output are flexible to accommodate decoders that, say, modulate their encoded results into complex or float types.
file_format: 1
2 changes: 1 addition & 1 deletion gr-fec/grc/fec_encoder.block.yml
Expand Up @@ -36,6 +36,6 @@ templates:
make: fec.encoder(${encoder}, ${itype.size}, ${otype.size})

documentation: |-
This is a GNU Radio adaptor for any FEC encoder following the generic_encoder API in the fec module. Input and output are flexible to accomodate encoders that, say, modulate their encoded results into complex or float types.
This is a GNU Radio adaptor for any FEC encoder following the generic_encoder API in the fec module. Input and output are flexible to accommodate encoders that, say, modulate their encoded results into complex or float types.
file_format: 1
2 changes: 1 addition & 1 deletion gr-fec/python/fec/polar/polar_channel_construction
Expand Up @@ -34,7 +34,7 @@ def setup_parser():
default='BEC')
parser.add_argument("-b", "--blocksize", type=int, dest="block_size",
help="specify block size of polar code (default=16)", default=16)
parser.add_argument("-s", "--desgin-snr", type=float, dest="design_snr",
parser.add_argument("-s", "--design-snr", type=float, dest="design_snr",
help="specify design SNR of polar code (default=0.0)", default=0.0)
parser.add_argument("-k", "--mu", type=int,
help="specify block size of polar code (default=2)", default=2)
Expand Down
2 changes: 1 addition & 1 deletion gr-filter/apps/gr_filter_design
Expand Up @@ -23,5 +23,5 @@
from gnuradio.filter import filter_design
import sys

# Call filter desgin main function
# Call filter design main function
filter_design.main(sys.argv)
2 changes: 1 addition & 1 deletion gr-filter/grc/filter_band_pass_filter.block.yml
Expand Up @@ -108,6 +108,6 @@ documentation: |-
Sample rate, cutoff frequency, and transition width are in Hertz.
The beta paramater only applies to the Kaiser window.
The beta parameter only applies to the Kaiser window.
file_format: 1
2 changes: 1 addition & 1 deletion gr-filter/grc/filter_band_reject_filter.block.yml
Expand Up @@ -103,6 +103,6 @@ documentation: |-
Sample rate, cutoff frequency, and transition width are in Hertz.
The beta paramater only applies to the Kaiser window.
The beta parameter only applies to the Kaiser window.
file_format: 1
2 changes: 1 addition & 1 deletion gr-filter/grc/filter_high_pass_filter.block.yml
Expand Up @@ -98,6 +98,6 @@ documentation: |-
Sample rate, cutoff frequency, and transition width are in Hertz.
The beta paramater only applies to the Kaiser window.
The beta parameter only applies to the Kaiser window.
file_format: 1
2 changes: 1 addition & 1 deletion gr-filter/grc/filter_low_pass_filter.block.yml
Expand Up @@ -98,6 +98,6 @@ documentation: |-
Sample rate, cutoff frequency, and transition width are in Hertz.
The beta paramater only applies to the Kaiser window.
The beta parameter only applies to the Kaiser window.
file_format: 1
2 changes: 1 addition & 1 deletion gr-filter/grc/filter_low_pass_xlating_filter.block.yml
Expand Up @@ -84,6 +84,6 @@ documentation: |-
Sample rate, cutoff frequency, and transition width are in Hertz.
The beta paramater only applies to the Kaiser window.
The beta parameter only applies to the Kaiser window.
file_format: 1
2 changes: 1 addition & 1 deletion gr-filter/grc/variable_band_reject_filter_taps.block.yml
Expand Up @@ -51,6 +51,6 @@ cpp_templates:
documentation: |-
This is a convenience wrapper for calling firdes.band_reject().
The beta paramater only applies to the Kaiser window.
The beta parameter only applies to the Kaiser window.
file_format: 1
2 changes: 1 addition & 1 deletion gr-filter/grc/variable_high_pass_filter_taps.block.yml
Expand Up @@ -47,6 +47,6 @@ cpp_templates:
documentation: |-
This variable is a convenience wrapper around a call to firdes.high_pass(...).
The beta paramater only applies to the Kaiser window.
The beta parameter only applies to the Kaiser window.
file_format: 1
2 changes: 1 addition & 1 deletion gr-filter/grc/variable_low_pass_filter_taps.block.yml
Expand Up @@ -47,6 +47,6 @@ cpp_templates:
documentation: |-
This variable is a convenience wrapper around a call to firdes.low_pass(...).
The beta paramater only applies to the Kaiser window.
The beta parameter only applies to the Kaiser window.
file_format: 1
2 changes: 1 addition & 1 deletion gr-filter/lib/pfb_synthesizer_ccf_impl.cc
Expand Up @@ -103,7 +103,7 @@ namespace gr {
void
pfb_synthesizer_ccf_impl::set_taps1(const std::vector<float> &taps)
{
// In this partitioning, we do a normal polyphase paritioning by
// In this partitioning, we do a normal polyphase partitioning by
// deinterleaving the taps into each filter:
//
// Prototype filter: [t0, t1, t2, t3, t4, t5, t6]
Expand Down
2 changes: 1 addition & 1 deletion gr-qtgui/lib/SpectrumGUIClass.cc
Expand Up @@ -150,7 +150,7 @@ SpectrumGUIClass::reset()
qApp->postEvent(_spectrumDisplayForm, new SpectrumWindowResetEvent());
}
_droppedEntriesCount = 0;
// Call the following function the the Spectrum Window Reset Event window
// Call the following function from the Spectrum Window Reset Event window
// ResetPendingGUIUpdateEvents();
}

Expand Down

0 comments on commit 925e110

Please sign in to comment.