Edits to Nlayer cylinder documentation #23
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
Codecov Report
@@ Coverage Diff @@
## main #23 +/- ##
=======================================
Coverage 48.71% 48.71%
=======================================
Files 16 16
Lines 1170 1170
=======================================
Hits 570 570
Misses 600 600
📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more |
heltonmc
reviewed
Apr 11, 2022
| @@ -14,7 +14,7 @@ | |||
| Compute the steady-state fluence in an N-layered cylinder. | |||
|
|
|||
| # Arguments | |||
| - `ρ`: source-detector separation in cylindrical coordinates (distance from middle z-axis of cylinder) (cm⁻¹) | |||
| - `ρ`: source-detector separation or tuple of separations in cylindrical coordinates (distance from middle z-axis of cylinder) (cm⁻¹) | |||
There was a problem hiding this comment.
I'm wondering if we should specify what types of the arguments should be explicitly. Like in this case rho can be an AbstractFloat or a Tuple{AbstractFloat} or essentially a tuple of abstract floats. It might make more sense to have these as union of types in the argument so
ρ::Union{AbstractFloat, Tuple{AbstractFloat}:
There was a problem hiding this comment.
Yeah I think that would be a good idea for sure
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.
Made some general edits, added in piece on tuple rho values, added examples with multiple rho, tested all tests (they worked except the multiple rho for flux which is an issue we are aware of).