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

 
 

bug #45166: [octave forge] (communications) typos in function docstrings

Submitter:  None
Submitted:  Fri 22 May 2015 06:10:34 PM UTC
 
Category:  Octave Forge Package Severity:  2 - Minor
Priority:  5 - Normal Item Group:  Documentation
Status:  Fixed Assigned to:  None
Originator Name:  Originator Email:  -email is unavailable-
Open/Closed:  * Closed Release:  * other
Operating System:  * Any
* Mandatory Fields

Add a New Comment (Rich Markup)
   

Comment Type & Canned Response:
       

 

( Jump to the original submission )

Tue 23 Nov 2021 05:03:28 PM UTC, comment #12: 

reviewing the points below, it appears that the doc changes are done and the other actual function issues are now addressed elsewhere. Closing as fixed.

Nicholas Jankowski <nrjank>
Project Member
Fri 12 Nov 2021 04:51:39 AM UTC, comment #11: 

Appears to be a completed docfix pushed to the codebase.  there were a few other issues brought up though.  are the all fixed, or pushed to bug 60270?  can this be closed?

Nicholas Jankowski <nrjank>
Project Member
Mon 22 Mar 2021 06:42:29 PM UTC, comment #10: 
Nir Krakauer <nir_krakauer>
Mon 22 Mar 2021 05:05:34 PM UTC, comment #9: 

Created bug #60270

Added the amdemod with a demo for the first 3 plots.

Fixed the docstrings for fmdemod (which is this bug) plus an error check.

(file #51115, file #51116)

Anonymous
Mon 22 Mar 2021 03:11:43 PM UTC, comment #8: 

If you want to work on a patch for amdemod, it would be helpful. You can file a bug report for Matlab compatibility with extra input arguments.

Nir Krakauer <nir_krakauer>
Sun 21 Mar 2021 11:34:00 AM UTC, comment #7: 

Nir, thank you for applying this patch.

For fmmod bug #45650 completes issues stated here.

For amdemod major improvements are needed
https://stackoverflow.com/questions/21902462/amplitude-modulation-using-builtin-octave-functions

Plots 1-3 work. (I can add this patch)

To make plot 4 amdemod needs to accept ini_phase, carramp, num, and den.

For fmdemod at a minimum freqdev needs to be added.

I do not know enough of this subject to fix these issues.
If someone can point me to some algorithms, I will attempt.

Anonymous
Thu 18 Mar 2021 08:01:17 PM UTC, comment #6: 

I applied your patch.
https://sourceforge.net/p/octave/communications/ci/cf52613462e97266e72be98cd58858c75202f42d/

Feel free to submit more if you see other changes needed.

Nir Krakauer <nir_krakauer>
Thu 18 Mar 2021 05:18:39 PM UTC, comment #5: 

Patch for ammod.

Fix the docstring.
Added demo

(file #51084)

Anonymous
Sat 23 May 2015 01:41:29 PM UTC, comment #4: 

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.

Anonymous
Sat 23 May 2015 12:10:28 PM UTC, comment #3: 

I'll take whatever help I can get. If you aren't prepared to work up a patch, can you at least provide a list of functions that you think are affected and the exact names of typos to look for?

Thanks.

Mike Miller <mtmiller>
Project Administrator
Sat 23 May 2015 07:43:16 AM UTC, comment #2: 

Hello Mike,

I'd really like to provide a patch for it, i guess it wouldn't require much time, but i never did it before and i really lack the basics for patch contribution to software projects... it's something i'm going to learn in the next future though. I hope i can be more useful the next time. Sorry for now...

Thanks guys for your work!

Anonymous
Fri 22 May 2015 10:56:05 PM UTC, comment #1: 

Thanks for your bug report. Would you be able to provide a patch to the sources fixing all of the relevant typos?

Bonus points if you can mark them up in texinfo properly! (e.g. @var{x}, @var{fs})

Mike Miller <mtmiller>
Project Administrator
Fri 22 May 2015 06:10:34 PM UTC, original submission:  

The documentation (either via "help", "info", online doc etc.) for some modulation functions included in the communication package, contains typos in the specification of the function parameters.

As example in [0] we read:

Function File: ammod (x, fc, fs)
Create the AM modulation of the signal x with carrier frequency fs. Where x is sample at frequency fs.

Where i suppose the carrier frequency should be "fc" and not "fs".
The same typos are present for other functions too.

Best regards.

[0] http://octave.sourceforge.net/communications/function/ammod.html

Anonymous

 

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

Attach Files:
   
   
Comment:
   

Attached Files
file #51115:  amdemod.patch added by None (2KiB - text/x-patch)
file #51116:  fmdemod.patch added by None (2KiB - text/x-patch)
file #51084:  ammod.patch added by None (2KiB - text/x-patch)

 

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)
  •  

    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 16 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2021-11-23 nrjank StatusNeed Info Fixed
        Open/ClosedOpen Closed
    2021-11-12 nrjank StatusConfirmed Need Info
    2021-03-22 None Attached File- Added amdemod.patch, #51115
        Attached File- Added fmdemod.patch, #51116
    2021-03-18 None Attached File- Added ammod.patch, #51084
    2020-02-28 mtmiller Assigned tomtmiller None
    2017-08-13 jwe Summarycommunications package: typos in function docstrings [octave forge] (communications) typos in function docstrings
    2015-05-28 mtmiller Assigned toNone mtmiller
    2015-05-22 mtmiller CategoryDocumentation Octave Forge Package
        Severity3 - Normal 2 - Minor
        Item GroupNone Documentation
        StatusNone Confirmed
        Release3.8.2 other
        Operating SystemGNU/Linux Any
        SummaryTypos in octave-communications package communications package: typos in function docstrings

    Back to the top


    Powered by Savane 3.9