Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation shows incorrect packages for iqplot #59

Open
patel999jay opened this issue Jan 10, 2021 · 1 comment
Open

Documentation shows incorrect packages for iqplot #59

patel999jay opened this issue Jan 10, 2021 · 1 comment
Assignees

Comments

@patel999jay
Copy link
Contributor

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
Copy link
Member

mchitre commented Jan 10, 2021

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

@mchitre mchitre self-assigned this Jan 10, 2021
@mchitre mchitre changed the title Documentation update Documentation shows incorrect packages for iqploft Jan 10, 2021
@mchitre mchitre changed the title Documentation shows incorrect packages for iqploft Documentation shows incorrect packages for iqplot Jan 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants