[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Octave-bug-tracker] [bug #45166] communications package: typos in funct
From: |
anonymous |
Subject: |
[Octave-bug-tracker] [bug #45166] communications package: typos in function docstrings |
Date: |
Sat, 23 May 2015 13:41:30 +0000 |
User-agent: |
Mozilla/5.0 (X11; Linux i686; rv:36.0) Gecko/20100101 Firefox/36.0 Iceweasel/36.0.4 |
Follow-up Comment #4, bug #45166 (project octave):
Sure, probably there is also a typo with the word "sample" which should be
"sampled". Here are the correct ones in the form:
<function>
"corrected docstring"
--
<ammod>
"Create the AM modulation of the signal x with carrier frequency fc. Where x
is sampled at frequency fs."
<fmmod>
"Create the FM modulation of the signal x with carrier frequency fc. Where x
is sampled at frequency fs."
<fmdemod>
"Create the FM demodulation of the signal x with carrier frequency fc. Where x
is sampled at frequency fs."
--
Maybe i'd also use a comma instead of a period to connect the second sentence
starting with "Where", and also uniform the docstring of the amdemod function
to the previous ones, in which case the correct strings become:
--
<ammod>
"Create the AM modulation of the signal x with carrier frequency fc, where x
is sampled at frequency fs."
<fmmod>
"Create the FM modulation of the signal x with carrier frequency fc, where x
is sampled at frequency fs."
<fmdemod>
"Create the FM demodulation of the signal x with carrier frequency fc, where x
is sampled at frequency fs."
<amdemod>
"Create the AM demodulation of the signal x with carrier frequency fc, where x
is sampled at frequency fs."
--
Hope it's enough, but let me know if i can do something else.
Bye.
_______________________________________________________
Reply to this item at:
<http://savannah.gnu.org/bugs/?45166>
_______________________________________________
Message sent via/by Savannah
http://savannah.gnu.org/