bugGNU Octave - Bugs: bug #45650, [octave forge] (communications)...

 
 

bug #45650: [octave forge] (communications) 'fmmod.m' help does not mention its last parameter (freqdev)

Submitter:  Francisco Albani <falbani>
Submitted:  Wed 29 Jul 2015 04:16:33 PM UTC
 
Category:  Octave Forge Package Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Documentation
Status:  Fixed Assigned to:  None
Originator Name:  Open/Closed:  * Closed
Release:  * other Operating System:  * Any
* Mandatory Fields

Add a New Comment (Rich Markup)
   

Comment Type & Canned Response:
       

 

Fri 12 Nov 2021 04:34:56 AM UTC, comment #5: 

Appears to be a completed docfix pushed to the codebase.  closing as fixed.

Nicholas Jankowski <nrjank>
Project Member
Thu 18 Mar 2021 08:14:53 PM UTC, comment #4: 
Nir Krakauer <nir_krakauer>
Fri 12 Mar 2021 12:51:46 PM UTC, comment #3: 

This is a small update.

Added Francisco's suggestions.
Fixed the nargin (now the function will work)
Added a demo.

(file #51048)

Anonymous
Wed 29 Jul 2015 07:57:41 PM UTC, comment #2: 

I forgot to mention that the 'nargin' comparison will also need to be changed.

Francisco Albani <falbani>
Wed 29 Jul 2015 07:20:49 PM UTC, comment #1: 

Thanks for the documentation review, I will take care of applying your suggested change.

Mike Miller <mtmiller>
Project Administrator
Wed 29 Jul 2015 04:16:33 PM UTC, original submission:  

Calling 'fmmod' without its last parameter results in error.

Original:

## -*- texinfo -*-
## @deftypefn {Function File} {} fmmod (@var{x}, @var{fc}, @var{fs})
## Create the FM modulation of the signal x with carrier frequency fs. Where
## x is sample at frequency fs.
## @seealso{ammod, fmdemod, amdemod}
## @end deftypefn

Suggested modification:

## -*- texinfo -*-
## @deftypefn {Function File} {} fmmod (@var{x}, @var{fc}, @var{fs}, @var{freqdev})
## Create the FM modulation of the signal x with carrier frequency fs. Where
## x is sample at frequency fs. freqdev is the maximum absolute frequency deviation, assuming x is in [-1:1].
## @seealso{ammod, fmdemod, amdemod}
## @end deftypefn

Francisco Albani <falbani>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

Attached Files
file #51048:  fmmod.patch added by None (3KiB - application/octet-stream)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by nrjank (Posted a comment)
  • -email is unavailable- added by nir_krakauer (Posted a comment)
  • -email is unavailable- added by jwe (Updated the item)
  • -email is unavailable- added by falbani (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only project members can vote.

     

     

     

     

    Follow 10 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2021-11-12 nrjank StatusPatch Submitted Fixed
        Open/ClosedOpen Closed
    2021-03-12 None Attached File- Added fmmod.patch, #51048
    2020-02-28 mtmiller Assigned tomtmiller None
    2018-07-02 jwe Summary[octave-forge] (communications) 'fmmod.m' help does not mention its last parameter (freqdev) [octave forge] (communications) 'fmmod.m' help does not mention its last parameter (freqdev)
    2017-08-11 jwe Summary[communications] 'fmmod.m' help does not mention its last parameter (freqdev) [octave-forge] (communications) 'fmmod.m' help does not mention its last parameter (freqdev)
    2015-07-29 mtmiller StatusNone Patch Submitted
        Assigned toNone mtmiller
        Release3.8.2 other
        Operating SystemGNU/Linux Any

    Back to the top


    Powered by Savane 3.9