Skip to content

Minor documentation typo in atco13 #29

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

Closed
jwoillez opened this issue Jan 29, 2016 · 7 comments
Closed

Minor documentation typo in atco13 #29

jwoillez opened this issue Jan 29, 2016 · 7 comments

Comments

@jwoillez
Copy link
Contributor

At https://github.com/liberfa/erfa/blob/master/src/atco13.c#L152
** eraAtioq quick ICRS to observed
should read
** eraAtioq quick CIRS to observed

@timj
Copy link
Contributor

timj commented Feb 1, 2016

Good spot. Have you reported this upstream to SOFA? It is preferred that we do not have to track fixes in ERFA that cause divergence with upstream SOFA.

@jwoillez
Copy link
Contributor Author

jwoillez commented Feb 1, 2016

No, not yet. Would you recommend using the [email protected] E-mail given in http://www.iausofa.org/tandc.html?
If that's the one, I would also add it to the front page documentation of the github page. I can issue a PR for this.

@timj
Copy link
Contributor

timj commented Feb 1, 2016

Yes, that email. It's a clear typo that I can't imagine will cause any issue. My personal preference is not to do a PR but to wait for the next SOFA release to include the fix. The more fixes that are done locally in ERFA the more pain is involved when bringing in SOFA updates. Not my call though. @eteq ?

@timj
Copy link
Contributor

timj commented Feb 1, 2016

Or were you saying a PR to change the Readme? Sorry 😄

@eteq
Copy link
Member

eteq commented Feb 1, 2016

@timj @jwoillez - I'd actually say may as well put in a PR to ERFA fixing this and we can just merge it. It's probably not worth a release only for this, but it can take a long time for SOFA to integrate this sort of thing, and part of the point of ERFA is to have this in place in the meantime. I'm not too worried that SOFA will have a different solution, simply because it's quite literally only two letters different... And the scripts to re-generate from a new version of SOFA will just take in the new change if they do include it so nothing lost.

@jwoillez
Copy link
Contributor Author

jwoillez commented Feb 2, 2016

I sent the following E-mail to SOFA and submitted the two PRs above.

Dear SOFA,
I would like to draw your attention to a minor typo in the documentation of the atco13 function.
Please find the details in #29.
Sincerely,
-Julien

@jwoillez
Copy link
Contributor Author

jwoillez commented Feb 3, 2016

The issue was acknowledged by SOFA, with the addition of a similar typo in atio13, hence the PR #30 update (8d52bc0).

@eteq eteq closed this as completed in #30 Feb 3, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants