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

 
 

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

Submitted by:  None
Submitted on:  Fri 22 May 2015 06:10:34 PM UTC  
 
Category:  Octave Forge Package Severity:  2 - Minor
Priority:  5 - Normal Item Group:  Documentation
Status:  Confirmed Assigned to:  Mike Miller <mtmiller>
Originator Name:  Originator Email:  -email is unavailable-
Open/Closed:  Open Release:  other
Operating System:  Any

Add a New Comment(Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

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 AdministratorIn charge of this item.
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 AdministratorIn charge of this item.
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:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by jwe (Updated the item)
  • -email is unavailable- added by mtmiller (Posted a comment)
  •  

    Do you think this task is very important?
    If so, you can add your encouragement to it.
    This task has 0 encouragements so far.

    Only project members can vote.

     

     

     

    Follow 9 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    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.3