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

The documentation is not updated, causing some examples to not work properly #8

Closed
ATTICUS2 opened this issue Mar 5, 2019 · 1 comment

Comments

@ATTICUS2
Copy link

ATTICUS2 commented Mar 5, 2019

hello!
https://github.com/DerekK88/PICwriter/blob/a98799316852cf773608df5f548bd04695f49510/docs/source/tutorial.rst#L183-L184
0eac4d2
The tutorial code in the above documentation does not work properly, as if it was caused by this commit 0eac4d2.

Error details:
ValueError: Warning!  Given the WaveguideTemplate 'bend radius' and 'spacing' specified, no spiral can be fit within the requested 'width'.  Please increase the 'width'.

@DerekK44
Copy link
Owner

DerekK44 commented Mar 6, 2019

Hello! Thanks for pointing my attention to this. The documentation was, in fact, in need of updating. The issue with the Spiral waveguides was a result of some changes to the Spiral class implementation, so the documentation version was not accurate.

I've just pushed some changes to the documentation to correct this now, with proper Spiral instantiation as detailed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants