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

Review documentation and code outputs for consistent application of 'Zenith Distance' vs 'Zenith Angle' #229

Open
jhaasdyk-au opened this issue Sep 11, 2024 · 1 comment
Labels
action assigned Work is being undertaken to resolve this issue doc update Document update or improvement needed

Comments

@jhaasdyk-au
Copy link
Collaborator

Brief description
An improvement of documentation to ensure the consistent use of 'Zenith Distance' vs 'Zenith Angle' for Type V measures.

Background [CHANGE OR DELETE IF NOT APPLICABLE]
DynAdjust v1.2.7
Current documentation appears to use 'Zenith Distance' and 'Zenith Angle' interchangeably.
Or, at very least to apply both terms to the Type V measurement.

See for example, among other:
Section 7.2.12
image
Section 7.2.15
image
Section C.2 (import log)
image

Basic requirements
Adopt consistent terminology throughout documentation and code, for this quantity
I have not perused the literature to see which is preferred, but Zenith Distance (V) appears to be more prevalent in our literature.
[An interesting and surprising terminology for the un-initiated, and non-astronomers among us]

Priority
Priority 3 - low

@jhaasdyk-au jhaasdyk-au added feature improve Improve or enhance an existing feature doc update Document update or improvement needed and removed feature improve Improve or enhance an existing feature labels Sep 11, 2024
@rogerfraser rogerfraser added the action assigned Work is being undertaken to resolve this issue label Feb 10, 2025
@rogerfraser
Copy link
Member

Thanks @jhaasdyk-au. This will be addressed in the next release (1.2.8).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
action assigned Work is being undertaken to resolve this issue doc update Document update or improvement needed
Projects
None yet
Development

No branches or pull requests

2 participants