Skip to content

#1665 clarify Orbit:MEANANOMALYATEPOCH docs #1696

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.

Sign up for GitHub

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
sshilovsky wants to merge 1 commit into from
Closed

#1665 clarify Orbit:MEANANOMALYATEPOCH docs #1696

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/source/structures/orbits/orbit.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,10 +197,10 @@ Structure
:type: :ref:`scalar <scalar>`
:access: Get only

`mean anomaly`_ in degrees. Even though orbital parameters are
`mean anomaly`_ in degrees at orbit epoch. Even though orbital parameters are
traditionally done in radians, in keeping with the kOS standard
of making everything into degrees, they are given as degrees by
kOS.
kOS. Orbit epoch is a complex term, refer to `#1665<https://github.com/KSP-KOS/KOS/issues/1665>`_ for details.
Copy link
Member

@Dunbaratu Dunbaratu Jul 5, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I like the idea of pointing people at the github issue about the problem, since it will also contain confusing information about what the mod used to be like...

Copy link
Member

@hvacengi hvacengi Jul 5, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree. It would be better if the documentation itself explained the concept of epoch. I'm not sure that we've actually fixed anything related to this though. @Dunbaratu were you going to add a suffix to handle the epoch issue in the review of #1660?

Copy link
Author

@sshilovsky sshilovsky Jul 5, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's just better than nothing. Might be reasonable to just notice that orbit epoch is not the same that the universe epoch. A link to KSP docs could be also helpful and better than to github issue.

I think something has to be done here. I'd lost a couple hours trying to catch a bug related to this.

Copy link
Author

@sshilovsky sshilovsky Jul 5, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is probably no reason to describe the concept of epoch right now, but let #1665 fix to address that.

This PR is just to save others efforts before #1665 is fixed.



.. attribute:: Orbit:TRANSITION
Expand Down