minimal improvement of the documentation #687
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
There was a problem hiding this comment.
My bad, I didn't realize this was ready for review due to the message in the original comment. There's an image missing in rnog.rst, other than that this is fine to be merged.
Nitpicky comments / rst tips - single backticks ` do... actually, I'm not sure, but single-spaced text (if that was the intention) requires double backticks ``
|
@sjoerd-bouma ping |
sjoerd-bouma
approved these changes
Jul 26, 2024
Comment on lines
+1203
to
+1220
| orientation_theta: float | ||
| orientation of the antenna, as a zenith angle (0deg is the zenith, 180deg is straight down); for LPDA: outward along boresight; for dipoles: upward along axis of azimuthal symmetry | ||
| orientation_phi: float | ||
| orientation of the antenna, as an azimuth angle (counting from East counterclockwise); for LPDA: outward along boresight; for dipoles: upward along axis of azimuthal symmetry | ||
| rotation_theta: float | ||
| rotation of the antenna, is perpendicular to 'orientation', for LPDAs: vector perpendicular to the plane containing the the tines | ||
| rotation_phi: float | ||
| rotation of the antenna, is perpendicular to 'orientation', for LPDAs: vector perpendicular to the plane containing the the tines | ||
| ff: array of floats | ||
| array of frequencies | ||
| thetas: array of floats | ||
| zenith angle of inicdent electric field | ||
| phis: array of floats | ||
| azimuth angle of incident electric field | ||
| H_phi: array of floats | ||
| the complex realized vector effective length of the ePhi polarization component | ||
| H_theta: array of floats | ||
| the complex realized vector effective length of the eTheta polarization component |
There was a problem hiding this comment.
I have no idea how this will be formatted, I'll assume you checked - if it looks very messy maybe making it a list as in the other two places this occurs would look better.
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.
This is not yet perfect (far from it actually). I hope in the following weeks we will improve on this step by step.