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 for Planner::new() does not mention power of two requirement #18

Closed
HEnquist opened this issue Mar 20, 2024 · 1 comment · Fixed by #20
Closed

Documentation for Planner::new() does not mention power of two requirement #18

HEnquist opened this issue Mar 20, 2024 · 1 comment · Fixed by #20
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@HEnquist
Copy link

The new() function for the planner panics if the length is not a power of two:

assert!(num_points > 0 && num_points.is_power_of_two());

But this is not mentioned in the docstring:

/// Panics if `num_points < 1`

@smu160 smu160 self-assigned this Mar 20, 2024
@smu160 smu160 added the documentation Improvements or additions to documentation label Mar 20, 2024
@HEnquist
Copy link
Author

The same problem is in the fft() method here:

/// Panics if `reals.len() != imags.len()`

@smu160 smu160 mentioned this issue Apr 11, 2024
@smu160 smu160 linked a pull request Apr 11, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants