Revised documentation for plan_fft #148
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Added warnings about serialization and overwriting inputs. - Section breaks and more info on FFTW planning. - Light copyediting.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #148 +/- ##
==========================================
- Coverage 94.83% 94.77% -0.06%
==========================================
Files 4 4
Lines 445 440 -5
==========================================
- Hits 422 417 -5
Misses 23 23 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Author
|
The failed integration test is due this issue with FastTransfoms.jl: to JuliaApproximation/FastTransforms.jl#263 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR revises the docstring for plan_fft.
My main impetus was to add a warning about serializing/sharing plans. Due to the name, I naively had assumed that "plans" were simply descriptive ("use this algorithm") and could be shared across processes (e.g., via @Everywhere). This seems to be a relatively common mistake, so I thought it was worth a warning.
I also did some light copy-editing and reformatting while adding that, which I think makes the text clearer.