IntegrateEllipsoids Better Documentation #248
Merged
Conversation
This file contains 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
Changed algorithm documentation as well as documentation in the source code.
|
Tester. Read the documentation. It should make it clearer what the algorithm is doing. |
peterfpeterson
added
Diffraction
peterfpeterson
added a commit
that referenced
this pull request
Feb 19, 2015
…lipsoids_docs IntegrateEllipsoids Better Documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Looking through the code for IntegrateEllipsoids, I think that the documentation is in general good, but is slightly lacking in some key areas. The fact that calculated results are pass-by-ref, already makes this quite tricky to read, so some additional documentation may help here.
See #10875