search

org-arl / arlpy

ARL Python Tools
BSD 3-Clause "New" or "Revised" License
118 stars 37 forks source link

Documentation shows incorrect packages for iqplot #59

Open patel999jay opened 3 years ago

patel999jay commented 3 years ago

I think in the documentation of arlpy.comms.psk() needs to update as last line of example code :

>>> import arlpy
>>> arlpy.comms.psk()
array([1+0j, -1+0j])
>>> arlpy.comms.psk(4)
array([0.707+0.707j, -0.707+0.707j, 0.707-0.707j, -0.707-0.707j])
>>> arlpy.comms.iqplot(arlpy.comms.psk(4))

I guess last line should be following:

>>> import arlpy
>>> arlpy.comms.psk()
array([1+0j, -1+0j])
>>> arlpy.comms.psk(4)
array([0.707+0.707j, -0.707+0.707j, 0.707-0.707j, -0.707-0.707j])
>>> arlpy.plot.iqplot(arlpy.comms.psk(4))

Attached Screenshot: image

mchitre commented 3 years ago

Yes, you are right, it's an error in the docs. I will update the docs. Thanks.