-
Notifications
You must be signed in to change notification settings - Fork 33
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
Confusion over name, id, frame properties #177
Comments
In what context are xxxxx_id and xxxxx_frame_code different for a reference frame? I think we can go with just xxxxx_id. |
As far as I know they are the same, just two different things we could standardize on |
For example, in NaifSpice, the instrument code (btw - why are we calling it ikid instead of something more descriptive like instrument_code):
We are converting a STRING to a CODE here (given by the Spice call), yet the string is referred to as "instrument_id", but "id" is in the property name returning an int. Are ids strings or ints??? Or should we be following the standard already laid out for us in Spice and call ints codes (or idcodes or...)? Also, is the Naif code for a body, for example, not different than the code for the body frame? That is actually a question I had for this frame chain implementation. Again, using NaifSpice as an example:
Seems like we are going about getting these values differently, so are they not different? (I just realized that I implemented target_frame_id in my last PR, so it looks like I went about this all wrong anyway, so maybe ids and frame ids are the same after-all?) Iit seems like we are having inconsistent naming or naming that just does not seem to convey what is actually being accomplished, as well. Again in NaifSpice:
Reference frame what? Name, code, class, etc. ? Also, what is it a frame for? Spacecraft, sensor, body...? You can see that this is for the target body by reading the logic, but should we not name our properties so that this is obvious without having to check the logic? |
I do like the idea that @scsides proposed about conventions above. |
There is confusion over what some of the properties are when they are returning a sting name, naif code, naif frame code. We should make this clear and consistent asap.
Possible Proposal:
xxxxx_name = returns a long name
xxxxx_short_name = returns an abbreviated short name
xxxxx_id = returns an integer
xxxxx_frame_code = returns a naif from code
The text was updated successfully, but these errors were encountered: